diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 000000000000..849ddff3b7ec --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +dist/ diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 000000000000..ada977056065 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,28 @@ +module.exports = { + env: { + browser: true, + commonjs: true, + es2020: true, + node: true + }, + parser: 'babel-eslint', + extends: [ + 'eslint:recommended', + 'standard' + ], + parserOptions: { + ecmaVersion: 11 + }, + rules: { + }, + overrides: [ + { + files: [ + '**/tests/**/*.js' + ], + env: { + jest: true + } + } + ] +} diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 877920ee7c94..69d8ee5fe9a1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -22,6 +22,6 @@ Thanks again! ### Check off the following: - [ ] All of the tests are passing. -- [ ] I have reviewed my changes in staging. +- [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**) - [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) - [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index 79936f169a74..e42b5d357b9e 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -22,7 +22,7 @@ module.exports = [ 'juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b', 'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512', 'pascalgn/automerge-action@c9bd182', - 'peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5', + 'peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326', 'peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8', 'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9', 'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e', diff --git a/.github/workflows/60-days-stale-check.yml b/.github/workflows/60-days-stale-check.yml index 1070b1311539..475d87d91a4d 100644 --- a/.github/workflows/60-days-stale-check.yml +++ b/.github/workflows/60-days-stale-check.yml @@ -1,22 +1,21 @@ name: 60 Days Stale Check on: schedule: - - cron: "40 16 * * *" # Run each day at 16:40 UTC / 8:40 PST + - cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST jobs: stale: runs-on: ubuntu-latest steps: - - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.' - stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.' - days-before-stale: 60 - days-before-close: -1 - only-labels: 'engineering' - stale-issue-label: 'stale' - stale-pr-label: 'stale' - exempt-pr-labels: 'never-stale' - exempt-issue-labels: 'never-stale' - + - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.' + stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.' + days-before-stale: 60 + days-before-close: -1 + only-labels: 'engineering' + stale-issue-label: 'stale' + stale-pr-label: 'stale' + exempt-pr-labels: 'never-stale' + exempt-issue-labels: 'never-stale' diff --git a/.github/workflows/auto-label-prs.yml b/.github/workflows/auto-label-prs.yml index 542204e49c70..eede9334b3d7 100644 --- a/.github/workflows/auto-label-prs.yml +++ b/.github/workflows/auto-label-prs.yml @@ -1,12 +1,12 @@ name: Auto label Pull Requests on: -- pull_request + pull_request: jobs: triage: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" + - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' diff --git a/.github/workflows/automerge-dependencies.yml b/.github/workflows/automerge-dependencies.yml index 76f3124a4360..42803d252b3c 100644 --- a/.github/workflows/automerge-dependencies.yml +++ b/.github/workflows/automerge-dependencies.yml @@ -3,10 +3,10 @@ name: Auto Merge Dependency Updates on: pull_request: paths: - - "package*.json" - - "Gemfile*" - - "Dockerfile" - - ".github/workflows/**" + - 'package*.json' + - 'Gemfile*' + - 'Dockerfile' + - '.github/workflows/**' pull_request_review: types: - edited diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml index a581bfb68fe3..5f6305232a66 100644 --- a/.github/workflows/automerge.yml +++ b/.github/workflows/automerge.yml @@ -23,14 +23,14 @@ jobs: if: contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash') steps: - name: automerge - uses: "pascalgn/automerge-action@c9bd182" + uses: 'pascalgn/automerge-action@c9bd182' env: - GITHUB_TOKEN: "${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}" - MERGE_METHOD_LABELS: "automerge=merge,autosquash=squash" - MERGE_COMMIT_MESSAGE: "pull-request-title" - MERGE_METHOD: "merge" - MERGE_FORKS: "true" - MERGE_RETRIES: "50" - MERGE_RETRY_SLEEP: "10000" # ten seconds - UPDATE_LABELS: "automerge,autosquash" - UPDATE_METHOD: "merge" + GITHUB_TOKEN: '${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}' + MERGE_METHOD_LABELS: 'automerge=merge,autosquash=squash' + MERGE_COMMIT_MESSAGE: 'pull-request-title' + MERGE_METHOD: 'merge' + MERGE_FORKS: 'true' + MERGE_RETRIES: '50' + MERGE_RETRY_SLEEP: '10000' # ten seconds + UPDATE_LABELS: 'automerge,autosquash' + UPDATE_METHOD: 'merge' diff --git a/.github/workflows/check-all-english-links.yml b/.github/workflows/check-all-english-links.yml index 6f4b2b46726a..f9c162029ae8 100644 --- a/.github/workflows/check-all-english-links.yml +++ b/.github/workflows/check-all-english-links.yml @@ -3,7 +3,7 @@ name: Check all English links on: workflow_dispatch: schedule: - - cron: "40 19 * * *" # once a day at 19:40 UTC / 11:40 PST + - cron: '40 19 * * *' # once a day at 19:40 UTC / 11:40 PST jobs: check_all_english_links: @@ -11,22 +11,22 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - name: npm ci - run: npm ci - - name: npm run build - run: npm run build - - name: Run script - run: script/check-english-links.js > broken_links.md - - if: ${{ failure() }} - name: Get title for issue - id: check - run: echo "::set-output name=title::$(head -1 broken_links.md)" - - if: ${{ failure() }} - name: Create issue from file - uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5 - with: - token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} - title: ${{ steps.check.outputs.title }} - content-filepath: ./broken_links.md - labels: broken link report + - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - name: npm ci + run: npm ci + - name: npm run build + run: npm run build + - name: Run script + run: script/check-english-links.js > broken_links.md + - if: ${{ failure() }} + name: Get title for issue + id: check + run: echo "::set-output name=title::$(head -1 broken_links.md)" + - if: ${{ failure() }} + name: Create issue from file + uses: peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326 + with: + token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + title: ${{ steps.check.outputs.title }} + content-filepath: ./broken_links.md + labels: broken link report diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 7d1a912d4bff..3a22f4a543aa 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -1,19 +1,19 @@ -name: "CodeQL analysis" +name: CodeQL analysis on: push: paths: - - '**/*.js' - - '.github/workflows/codeql.yml' + - '**/*.js' + - '.github/workflows/codeql.yml' jobs: build: - runs-on: ubuntu-latest + runs-on: ubuntu-latest steps: - - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - uses: github/codeql-action/init@v1 - with: - languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!) - - uses: github/codeql-action/analyze@v1 - continue-on-error: true + - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - uses: github/codeql-action/init@v1 + with: + languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!) + - uses: github/codeql-action/analyze@v1 + continue-on-error: true diff --git a/.github/workflows/crowdin.yml b/.github/workflows/crowdin.yml index 584f2c2c8065..48edbafa9aea 100644 --- a/.github/workflows/crowdin.yml +++ b/.github/workflows/crowdin.yml @@ -3,7 +3,7 @@ name: Crowdin Sync on: workflow_dispatch: schedule: - - cron: "33 2 * * *" # every day at 2:33 UTC at least until automerge is working + - cron: '33 2 * * *' # every day at 2:33 UTC at least until automerge is working jobs: sync_with_crowdin: @@ -20,7 +20,7 @@ jobs: upload_translations: false download_translations: true create_pull_request: true - + # Using a custom config temporarily to avoid clobbering the existing crowdin.yml # that is used by the github-help-docs OAuth integration. config: 'crowdin.yml' @@ -35,17 +35,15 @@ jobs: crowdin_branch_name: main env: - # Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here + # Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here # so that subsequent workflows will be able to run on the pull request created by this workflow. GITHUB_TOKEN: ${{ secrets.OCTOGLOT_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} # This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string # See "API v2" on https://crowdin.com/project//settings#api CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }} - + # A personal access token, not to be confused with Crowdin API v1 "API key" # See https://crowdin.com/settings#api-key to generate a token # This token was created by logging into Crowdin with the octoglot user CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} - - diff --git a/.github/workflows/dry-run-sync-algolia-search-indices.yml b/.github/workflows/dry-run-sync-algolia-search-indices.yml index 685d6c087f8f..c11e98624371 100644 --- a/.github/workflows/dry-run-sync-algolia-search-indices.yml +++ b/.github/workflows/dry-run-sync-algolia-search-indices.yml @@ -9,23 +9,23 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - name: checkout - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d - with: - node-version: 14.x - - name: cache node modules - uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - name: npm ci - run: npm ci - - name: (Dry run) sync indices - env: - ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} - ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: npm run sync-search-dry-run + - name: checkout + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d + with: + node-version: 14.x + - name: cache node modules + uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-node- + - name: npm ci + run: npm ci + - name: (Dry run) sync indices + env: + ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} + ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: npm run sync-search-dry-run diff --git a/.github/workflows/first-responder-docs-content.yml b/.github/workflows/first-responder-docs-content.yml index 59b584026573..64e2d5ea1ac2 100644 --- a/.github/workflows/first-responder-docs-content.yml +++ b/.github/workflows/first-responder-docs-content.yml @@ -1,7 +1,12 @@ name: First responder docs-content on: pull_request: - types: [reopened, opened, ready_for_review, closed, unlabeled] + types: + - reopened + - opened + - ready_for_review + - closed + - unlabeled jobs: first-responder-triage-pr: @@ -10,46 +15,46 @@ jobs: runs-on: ubuntu-latest steps: - - name: Check if the event originated from a team member - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - id: set-result - with: - github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - result-encoding: string - script: | - const repoName = context.payload.repository.name - const ownerName = context.payload.repository.owner.login - const issueNumber = (context.eventName === "issues") ? context.payload.issue.number : context.payload.number - const updatedIssueInformation = await github.issues.get({ - owner: ownerName, - repo: repoName, - issue_number: issueNumber - }) - const teamMembers = await github.request( - `/orgs/github/teams/docs/members` - ) - const logins = teamMembers.data.map(member => member.login) - // ignore PRs opened by docs bot accounts - logins.push('Octomerger', 'octoglot') - if (logins.some(login => login === updatedIssueInformation.data.user.login)) { - console.log(`This issue or pull request was authored by a member of the github/docs team.`) - return 'true' - } - console.log(`This issue or pull request was authored by an external contributor.`) - return 'false' - - name: Label external contributor pull requests with docs-content-fr - uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e - if: steps.set-result.outputs.result == 'false' - with: - repo-token: "${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}" - add-labels: "docs-content-fr" - - name: Triage to FR PR project column - uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 - if: steps.set-result.outputs.result == 'false' - with: - action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} - project-url: "https://github.com/orgs/github/projects/1367" - column-name: "Docs-internal external contributor PRs" + - name: Check if the event originated from a team member + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + id: set-result + with: + github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} + result-encoding: string + script: | + const repoName = context.payload.repository.name + const ownerName = context.payload.repository.owner.login + const issueNumber = (context.eventName === "issues") ? context.payload.issue.number : context.payload.number + const updatedIssueInformation = await github.issues.get({ + owner: ownerName, + repo: repoName, + issue_number: issueNumber + }) + const teamMembers = await github.request( + `/orgs/github/teams/docs/members` + ) + const logins = teamMembers.data.map(member => member.login) + // ignore PRs opened by docs bot accounts + logins.push('Octomerger', 'octoglot') + if (logins.some(login => login === updatedIssueInformation.data.user.login)) { + console.log(`This issue or pull request was authored by a member of the github/docs team.`) + return 'true' + } + console.log(`This issue or pull request was authored by an external contributor.`) + return 'false' + - name: Label external contributor pull requests with docs-content-fr + uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e + if: steps.set-result.outputs.result == 'false' + with: + repo-token: '${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}' + add-labels: 'docs-content-fr' + - name: Triage to FR PR project column + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + if: steps.set-result.outputs.result == 'false' + with: + action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + project-url: 'https://github.com/orgs/github/projects/1367' + column-name: 'Docs-internal external contributor PRs' first-responder-remove-pr: name: Remove PR from FR project board @@ -57,29 +62,29 @@ jobs: runs-on: ubuntu-latest steps: - - name: Remove card from project - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - result-encoding: string - script: | - const issueToRemove = context.payload.number - const cards = await github.projects.listCards({ - column_id: 11130889 - }) - cards.data.forEach(card => { - if (card.content_url) { - const cardIssueNumber = parseInt(card.content_url.split('/').pop(), 10) - if (cardIssueNumber === issueToRemove) { - const cards = github.projects.deleteCard({ - card_id: card.id - }) + - name: Remove card from project + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} + result-encoding: string + script: | + const issueToRemove = context.payload.number + const cards = await github.projects.listCards({ + column_id: 11130889 + }) + cards.data.forEach(card => { + if (card.content_url) { + const cardIssueNumber = parseInt(card.content_url.split('/').pop(), 10) + if (cardIssueNumber === issueToRemove) { + const cards = github.projects.deleteCard({ + card_id: card.id + }) + } } - } - }) - - name: Remove docs-content-fr label if not already removed - if: github.event.action == 'closed' - uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e - with: - repo-token: "${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}" - remove-labels: "docs-content-fr" + }) + - name: Remove docs-content-fr label if not already removed + if: github.event.action == 'closed' + uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e + with: + repo-token: '${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}' + remove-labels: 'docs-content-fr' diff --git a/.github/workflows/js-lint.yml b/.github/workflows/js-lint.yml index ad4cbbb0cc4d..3da0e854a213 100644 --- a/.github/workflows/js-lint.yml +++ b/.github/workflows/js-lint.yml @@ -21,7 +21,7 @@ jobs: with: cancel_others: 'false' github_token: ${{ github.token }} - paths: '["**/*.js", "package*.json", ".github/workflows/js-lint.yml"]' + paths: '["**/*.js", "package*.json", ".github/workflows/js-lint.yml", ".eslint*"]' lint: runs-on: ubuntu-latest @@ -53,7 +53,7 @@ jobs: run: npm ci - name: Run linter - run: npx standard + run: npx eslint . - name: Check dependencies run: npm run check-deps diff --git a/.github/workflows/merged-notification.yml b/.github/workflows/merged-notification.yml index 206d843a8788..96d2e47b7566 100644 --- a/.github/workflows/merged-notification.yml +++ b/.github/workflows/merged-notification.yml @@ -1,7 +1,8 @@ name: Merged notification on: pull_request_target: - types: ['closed'] + types: + - 'closed' jobs: comment: diff --git a/.github/workflows/pa11y.yml b/.github/workflows/pa11y.yml index 27f58094bccc..2ced06546e81 100644 --- a/.github/workflows/pa11y.yml +++ b/.github/workflows/pa11y.yml @@ -1,8 +1,8 @@ -name: "Pa11y" +name: Pa11y on: workflow_dispatch: schedule: - - cron: "25 17 * * *" # once a day at 17:25 UTC / 11:50 PST + - cron: '25 17 * * *' # once a day at 17:25 UTC / 11:50 PST jobs: test: runs-on: ubuntu-latest diff --git a/.github/workflows/ping-staging-apps.yml b/.github/workflows/ping-staging-apps.yml index bbfed9399c64..400c0c00dd56 100644 --- a/.github/workflows/ping-staging-apps.yml +++ b/.github/workflows/ping-staging-apps.yml @@ -2,7 +2,7 @@ name: Ping staging apps on: schedule: - - cron: "*/20 * * * *" # every twenty minutes + - cron: '*/20 * * * *' # every twenty minutes jobs: ping_staging_apps: @@ -12,10 +12,10 @@ jobs: env: HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }} steps: - - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - name: npm ci - run: npm ci - - name: npm run build - run: npm run build - - name: Run script - run: script/ping-staging-apps.js + - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - name: npm ci + run: npm ci + - name: npm run build + run: npm run build + - name: Run script + run: script/ping-staging-apps.js diff --git a/.github/workflows/remove-unused-assets.yml b/.github/workflows/remove-unused-assets.yml index ad826b0f7166..f8541acdf940 100644 --- a/.github/workflows/remove-unused-assets.yml +++ b/.github/workflows/remove-unused-assets.yml @@ -5,7 +5,7 @@ env: on: schedule: - - cron: "20 15 * * 0" # run every Sunday at 20:15 UTC / 12:15 PST + - cron: '20 15 * * 0' # run every Sunday at 20:15 UTC / 12:15 PST jobs: remove_unused_assets: @@ -13,42 +13,43 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - if: ${{ env.FREEZE == 'true' }} - run: | - echo 'The repo is currently frozen! Exiting this workflow.' - exit 1 # prevents further steps from running - - name: Checkout - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - name: npm ci - run: npm ci - - name: Run scripts - run: | - script/remove-unused-assets.js > results.md - script/remove-extraneous-translation-files.js - - name: Get script results to use in PR body - id: results - uses: juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512 - with: - path: ./results.md - - name: Remove script results file - run: rm -rf ./results.md - - name: Create pull request - uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8 - with: - # need to use a token with repo and workflow scopes for this step - token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - commit-message: Action ran script/remove-unused-assets.js - title: Remove unused assets - body: "Hello! This PR removes some files that exist in the repo but are not used in content or data files:\n\n - ${{ steps.results.outputs.content }} - \n\nIf you have any questions, please contact @github/docs-engineering." - labels: unused assets - project: Core docs work for the current week - project-column: Should do - branch: remove-unused-assets - - if: ${{ failure() }} - name: Delete remote branch (if previous steps failed) - uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - branches: remove-unused-assets + - if: ${{ env.FREEZE == 'true' }} + run: | + echo 'The repo is currently frozen! Exiting this workflow.' + exit 1 # prevents further steps from running + - name: Checkout + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - name: npm ci + run: npm ci + - name: Run scripts + run: | + script/remove-unused-assets.js > results.md + script/remove-extraneous-translation-files.js + - name: Get script results to use in PR body + id: results + uses: juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512 + with: + path: ./results.md + - name: Remove script results file + run: rm -rf ./results.md + - name: Create pull request + uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8 + with: + # need to use a token with repo and workflow scopes for this step + token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + commit-message: Action ran script/remove-unused-assets.js + title: Remove unused assets + body: + "Hello! This PR removes some files that exist in the repo but are not used in content or data files:\n\n + ${{ steps.results.outputs.content }} + \n\nIf you have any questions, please contact @github/docs-engineering." + labels: unused assets + project: Core docs work for the current week + project-column: Should do + branch: remove-unused-assets + - if: ${{ failure() }} + name: Delete remote branch (if previous steps failed) + uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branches: remove-unused-assets diff --git a/.github/workflows/repo-freeze-check.yml b/.github/workflows/repo-freeze-check.yml index 1ea8d4b3c325..dbe52b0cd1e5 100644 --- a/.github/workflows/repo-freeze-check.yml +++ b/.github/workflows/repo-freeze-check.yml @@ -19,9 +19,8 @@ jobs: name: Prevent merging during deployment freezes runs-on: ubuntu-latest steps: - - - name: Fail if repo merges are paused - if: ${{ env.FREEZE == 'true' }} - run: | - echo 'Merges into the "main" branch on this repo are currently paused!' - exit 1 + - name: Fail if repo merges are paused + if: ${{ env.FREEZE == 'true' }} + run: | + echo 'Merges into the "main" branch on this repo are currently paused!' + exit 1 diff --git a/.github/workflows/repo-freeze-reminders.yml b/.github/workflows/repo-freeze-reminders.yml index 83a970839545..e6f7eb479eca 100644 --- a/.github/workflows/repo-freeze-reminders.yml +++ b/.github/workflows/repo-freeze-reminders.yml @@ -2,7 +2,7 @@ name: Repo Freeze Reminders on: schedule: - - cron: "00 11 * * *" # once per day around 11:00am UTC + - cron: '00 11 * * *' # once per day around 11:00am UTC env: FREEZE: ${{ secrets.FREEZE }} @@ -13,13 +13,12 @@ jobs: runs-on: ubuntu-latest if: github.repository == 'github/docs-internal' steps: - - - name: Send Slack notification if repo is frozen - if: ${{ env.FREEZE == 'true' }} - uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 - env: - SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} - SLACK_USERNAME: docs-repo-sync - SLACK_ICON_EMOJI: ':freezing_face:' - SLACK_COLOR: '#51A0D5' # Carolina Blue - SLACK_MESSAGE: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen! + - name: Send Slack notification if repo is frozen + if: ${{ env.FREEZE == 'true' }} + uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 + env: + SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} + SLACK_USERNAME: docs-repo-sync + SLACK_ICON_EMOJI: ':freezing_face:' + SLACK_COLOR: '#51A0D5' # Carolina Blue + SLACK_MESSAGE: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen! diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index e96e855284c1..b33242e90be3 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -1,14 +1,14 @@ # The docs.github.com project has two repositories: github/docs (public) and github/docs-internal (private) -# +# # This GitHub Actions workflow keeps the main branch of those two repos in sync. -# +# # For more details, see https://github.com/repo-sync/repo-sync#how-it-works name: Repo Sync on: schedule: - - cron: "*/15 * * * *" # every 15 minutes + - cron: '*/15 * * * *' # every 15 minutes env: FREEZE: ${{ secrets.FREEZE }} @@ -18,65 +18,63 @@ jobs: name: Check for deployment freezes runs-on: ubuntu-latest steps: - - - name: Exit if repo is frozen - if: ${{ env.FREEZE == 'true' }} - run: | - echo 'The repo is currently frozen! Exiting this workflow.' - exit 1 # prevents further steps from running + - name: Exit if repo is frozen + if: ${{ env.FREEZE == 'true' }} + run: | + echo 'The repo is currently frozen! Exiting this workflow.' + exit 1 # prevents further steps from running repo-sync: name: Repo Sync needs: check-freezer runs-on: ubuntu-latest steps: + - name: Check out repo + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - name: Check out repo - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - - name: Sync repo to branch - uses: repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88 - env: - GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - with: - source_repo: ${{ secrets.SOURCE_REPO }} # https://${access_token}@github.com/github/the-other-repo.git - source_branch: main - destination_branch: repo-sync - github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + - name: Sync repo to branch + uses: repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88 + env: + GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + with: + source_repo: ${{ secrets.SOURCE_REPO }} # https://${access_token}@github.com/github/the-other-repo.git + source_branch: main + destination_branch: repo-sync + github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - - name: Create pull request - uses: repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d - env: - GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - with: - source_branch: repo-sync - destination_branch: main - pr_title: "repo sync" - pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!" - pr_label: automerge,autoupdate - github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + - name: Create pull request + uses: repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d + env: + GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + with: + source_branch: repo-sync + destination_branch: main + pr_title: 'repo sync' + pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!" + pr_label: automerge,autoupdate + github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - - name: Find pull request - uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b - id: find-pull-request - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - branch: repo-sync - base: main + - name: Find pull request + uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b + id: find-pull-request + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + branch: repo-sync + base: main - - name: Approve pull request - if: ${{ steps.find-pull-request.outputs.number }} - uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - number: ${{ steps.find-pull-request.outputs.number }} + - name: Approve pull request + if: ${{ steps.find-pull-request.outputs.number }} + uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + number: ${{ steps.find-pull-request.outputs.number }} - - name: Send Slack notification if workflow fails - uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 - if: ${{ failure() }} - env: - SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} - SLACK_USERNAME: docs-repo-sync - SLACK_ICON_EMOJI: ':ohno:' - SLACK_COLOR: '#B90E0A' # Crimson - SLACK_MESSAGE: The last repo-sync run for ${{github.repository}} failed. See https://github.com/${{github.repository}}/actions?query=workflow%3A%22Repo+Sync%22 + - name: Send Slack notification if workflow fails + uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 + if: ${{ failure() }} + env: + SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} + SLACK_USERNAME: docs-repo-sync + SLACK_ICON_EMOJI: ':ohno:' + SLACK_COLOR: '#B90E0A' # Crimson + SLACK_MESSAGE: The last repo-sync run for ${{github.repository}} failed. See https://github.com/${{github.repository}}/actions?query=workflow%3A%22Repo+Sync%22 diff --git a/.github/workflows/send-eng-issues-to-backlog.yml b/.github/workflows/send-eng-issues-to-backlog.yml index 9c51f298779e..11ca0afd2f8d 100644 --- a/.github/workflows/send-eng-issues-to-backlog.yml +++ b/.github/workflows/send-eng-issues-to-backlog.yml @@ -1,20 +1,22 @@ name: Send Issue to EPD backlog -on: - issues: - types: [labeled, reopened] - +on: + issues: + types: + - labeled + - reopened + jobs: triage: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest continue-on-error: true steps: - - name: Add issues with engineering label to project board - if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design') - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + - name: Add issues with engineering label to project board + if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} script: | var column_id = 9659080; try { diff --git a/.github/workflows/start-new-engineering-pr-workflow.yml b/.github/workflows/start-new-engineering-pr-workflow.yml index e223ee53ae59..1d7b16416178 100644 --- a/.github/workflows/start-new-engineering-pr-workflow.yml +++ b/.github/workflows/start-new-engineering-pr-workflow.yml @@ -1,9 +1,11 @@ name: Start new engineering PR workflow -on: +on: pull_request_target: - types: [opened, reopened] - + types: + - opened + - reopened + jobs: triage: runs-on: ubuntu-latest @@ -12,52 +14,52 @@ jobs: DRAFT_COLUMN_ID: 10095775 REGULAR_COLUMN_ID: 10095779 steps: - - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - continue-on-error: true - with: + - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + continue-on-error: true + with: github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} script: | - // Only assign the engineering folks - try { - await github.teams.getMembershipForUserInOrg({ - org: 'github', - team_slug: 'docs-engineering', - username: context.payload.sender.login, - }); - } catch(err) { - return - } + // Only assign the engineering folks + try { + await github.teams.getMembershipForUserInOrg({ + org: 'github', + team_slug: 'docs-engineering', + username: context.payload.sender.login, + }); + } catch(err) { + return + } - // Set column ID - const column_id = context.payload.pull_request.draft - ? process.env.DRAFT_COLUMN_ID - : process.env.REGULAR_COLUMN_ID + // Set column ID + const column_id = context.payload.pull_request.draft + ? process.env.DRAFT_COLUMN_ID + : process.env.REGULAR_COLUMN_ID - // Try to create the card on the GitHub Project - try { - await github.projects.createCard({ - column_id: column_id, - content_type: 'PullRequest', - content_id: context.payload.pull_request.id - }); - } catch(error) { - console.log(error); - } + // Try to create the card on the GitHub Project + try { + await github.projects.createCard({ + column_id: column_id, + content_type: 'PullRequest', + content_id: context.payload.pull_request.id + }); + } catch(error) { + console.log(error); + } - // Try to set the author as the assignee - const owner = context.payload.repository.owner.login - const repo = context.payload.repository.name + // Try to set the author as the assignee + const owner = context.payload.repository.owner.login + const repo = context.payload.repository.name - try { - await github.issues.addAssignees({ - owner: owner, - repo: repo, - issue_number: context.payload.pull_request.number, - assignees: [ - context.payload.sender.login - ] - }); - } catch(error) { - console.log(error); - } + try { + await github.issues.addAssignees({ + owner: owner, + repo: repo, + issue_number: context.payload.pull_request.number, + assignees: [ + context.payload.sender.login + ] + }); + } catch(error) { + console.log(error); + } diff --git a/.github/workflows/sync-algolia-search-indices.yml b/.github/workflows/sync-algolia-search-indices.yml index 37dc97e8e394..04de1aaa1fad 100644 --- a/.github/workflows/sync-algolia-search-indices.yml +++ b/.github/workflows/sync-algolia-search-indices.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: push: branches: - - main + - main jobs: updateIndices: @@ -12,29 +12,29 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - name: checkout - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d - with: - node-version: 14.x - - name: cache node modules - uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - name: npm ci - run: npm ci - - name: sync indices - env: - ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} - ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: npm run sync-search - - name: Send slack notification if workflow run fails - uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 - if: failure() - env: - SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} - SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. See https://github.com/github/docs-internal/actions?query=workflow%3AAlgolia + - name: checkout + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d + with: + node-version: 14.x + - name: cache node modules + uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-node- + - name: npm ci + run: npm ci + - name: sync indices + env: + ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} + ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: npm run sync-search + - name: Send slack notification if workflow run fails + uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 + if: failure() + env: + SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} + SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. See https://github.com/github/docs-internal/actions?query=workflow%3AAlgolia diff --git a/.github/workflows/test-translations.yml b/.github/workflows/test-translations.yml index f149d5df9224..dc49ad45f625 100644 --- a/.github/workflows/test-translations.yml +++ b/.github/workflows/test-translations.yml @@ -4,7 +4,7 @@ name: Node.js Tests - Translations on: schedule: - - cron: "10 20 * * *" # once a day at 20:10 UTC / 12:10 PST + - cron: '10 20 * * *' # once a day at 20:10 UTC / 12:10 PST jobs: lint: @@ -38,7 +38,7 @@ jobs: run: npm ci - name: Run linter - run: npx standard + run: npx eslint . - name: Check dependencies run: npm run check-deps @@ -78,4 +78,4 @@ jobs: - name: Run tests run: npx jest tests/${{ matrix.test-group }}/ env: - NODE_OPTIONS: "--max_old_space_size=4096" + NODE_OPTIONS: '--max_old_space_size=4096' diff --git a/.github/workflows/test-windows.yml b/.github/workflows/test-windows.yml index 8140a277c6e9..330d0a15066e 100644 --- a/.github/workflows/test-windows.yml +++ b/.github/workflows/test-windows.yml @@ -5,10 +5,7 @@ name: Node.js Tests - Windows on: workflow_dispatch: schedule: - - cron: "50 19 * * *" # once a day at 19:50 UTC / 11:50 PST - -env: - CI: true + - cron: '50 19 * * *' # once a day at 19:50 UTC / 11:50 PST jobs: test: @@ -48,4 +45,4 @@ jobs: - name: Run tests run: npx jest tests/${{ matrix.test-group }}/ env: - NODE_OPTIONS: "--max_old_space_size=4096" + NODE_OPTIONS: '--max_old_space_size=4096' diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index eaec563ed541..502eeafab678 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -77,11 +77,11 @@ jobs: name: Run tests run: npx jest tests/${{ matrix.test-group }}/ env: - NODE_OPTIONS: "--max_old_space_size=4096" + NODE_OPTIONS: '--max_old_space_size=4096' - name: Send Slack notification if workflow fails uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815 if: failure() && github.ref == 'early-access' env: SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} - SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access" + SLACK_MESSAGE: 'Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access' diff --git a/.github/workflows/translations.yml b/.github/workflows/translations.yml index e6af49e61ce4..8bfd5ba5d877 100644 --- a/.github/workflows/translations.yml +++ b/.github/workflows/translations.yml @@ -2,7 +2,7 @@ name: Translations on: schedule: - - cron: "20 19 * * *" # once a day at 19:20 UTC / 11:20 PST + - cron: '20 19 * * *' # once a day at 19:20 UTC / 11:20 PST env: FREEZE: ${{ secrets.FREEZE }} @@ -12,45 +12,45 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - if: ${{ env.FREEZE == 'true' }} - run: | - echo 'The repo is currently frozen! Exiting this workflow.' - exit 1 # prevents further steps from running - - name: Find original Pull Request - uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b - id: pr - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - branch: translations - - if: ${{ steps.pr.outputs.number }} - name: Check if already labeled - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - id: has-label - with: - script: | - const { data: labels } = await github.issues.listLabelsOnIssue({ - owner: context.repo.owner, - repo: context.repo.repo, - issue_number: ${{ steps.pr.outputs.number }} - }) - if (labels.find(label => label.name === 'automerge')) { - return 'ok' - } - - if: ${{ !steps.has-label.outputs.result }} - name: Approve Pull Request - uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - number: ${{ steps.pr.outputs.number }} - - if: ${{ !steps.has-label.outputs.result }} - name: Add automerge label - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - script: | - github.issues.addLabels({ - owner: context.repo.owner, - repo: context.repo.repo, - issue_number: ${{ steps.pr.outputs.number }}, - labels: ['automerge'] - }) + - if: ${{ env.FREEZE == 'true' }} + run: | + echo 'The repo is currently frozen! Exiting this workflow.' + exit 1 # prevents further steps from running + - name: Find original Pull Request + uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b + id: pr + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + branch: translations + - if: ${{ steps.pr.outputs.number }} + name: Check if already labeled + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + id: has-label + with: + script: | + const { data: labels } = await github.issues.listLabelsOnIssue({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: ${{ steps.pr.outputs.number }} + }) + if (labels.find(label => label.name === 'automerge')) { + return 'ok' + } + - if: ${{ !steps.has-label.outputs.result }} + name: Approve Pull Request + uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + number: ${{ steps.pr.outputs.number }} + - if: ${{ !steps.has-label.outputs.result }} + name: Add automerge label + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + github.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: ${{ steps.pr.outputs.number }}, + labels: ['automerge'] + }) diff --git a/.github/workflows/triage-issue-comments.yml b/.github/workflows/triage-issue-comments.yml index 876e4835457a..2d609b758faf 100644 --- a/.github/workflows/triage-issue-comments.yml +++ b/.github/workflows/triage-issue-comments.yml @@ -1,7 +1,8 @@ name: Triage new issue comments on: issue_comment: - types: [created] + types: + - created jobs: triage-issue-comments: @@ -9,38 +10,38 @@ jobs: runs-on: ubuntu-latest steps: - - name: Check if the event originated from a team member - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - id: is-internal-contributor - with: - github-token: ${{secrets.GITHUB_TOKEN}} - result-encoding: string - script: | - const repo = context.payload.repository.name - const org = context.payload.repository.owner.login - const actor = context.actor - let collaboratorStatus = '' - try { - collaboratorStatus = await github.request('GET /repos/{owner}/{repo}/collaborators/{username}', { - owner: org, - repo: repo, - username: actor - }) - console.log(`This issue was commented on by a Hubber.`) - return 'true' - } catch (error) { - console.log(`This issue was commented on by an external contributor.`) - return 'false' - } - - name: Label issues with new comments with 'triage' - uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e - if: (steps.is-internal-contributor.outputs.result == 'false') - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - add-labels: "triage" - - name: Triage to project board - uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 - with: - action-token: ${{ secrets.GITHUB_TOKEN }} - project-url: "https://github.com/github/docs/projects/1" - column-name: "Triage" + - name: Check if the event originated from a team member + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + id: is-internal-contributor + with: + github-token: ${{secrets.GITHUB_TOKEN}} + result-encoding: string + script: | + const repo = context.payload.repository.name + const org = context.payload.repository.owner.login + const actor = context.actor + let collaboratorStatus = '' + try { + collaboratorStatus = await github.request('GET /repos/{owner}/{repo}/collaborators/{username}', { + owner: org, + repo: repo, + username: actor + }) + console.log(`This issue was commented on by a Hubber.`) + return 'true' + } catch (error) { + console.log(`This issue was commented on by an external contributor.`) + return 'false' + } + - name: Label issues with new comments with 'triage' + uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e + if: (steps.is-internal-contributor.outputs.result == 'false') + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' + add-labels: 'triage' + - name: Triage to project board + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + with: + action-token: ${{ secrets.GITHUB_TOKEN }} + project-url: 'https://github.com/github/docs/projects/1' + column-name: 'Triage' diff --git a/.github/workflows/triage-issues.yml b/.github/workflows/triage-issues.yml index 91d1ca4442ca..61280b515410 100644 --- a/.github/workflows/triage-issues.yml +++ b/.github/workflows/triage-issues.yml @@ -1,7 +1,9 @@ name: Triage new issues on: issues: - types: [reopened, opened] + types: + - reopened + - opened jobs: triage_issues: @@ -9,14 +11,14 @@ jobs: runs-on: ubuntu-latest steps: - - name: Label new issues with 'triage' - uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - add-labels: "triage" - - name: Triage to project board - uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 - with: - action-token: ${{ secrets.GITHUB_TOKEN }} - project-url: "https://github.com/github/docs/projects/1" - column-name: "Triage" + - name: Label new issues with 'triage' + uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' + add-labels: 'triage' + - name: Triage to project board + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + with: + action-token: ${{ secrets.GITHUB_TOKEN }} + project-url: 'https://github.com/github/docs/projects/1' + column-name: 'Triage' diff --git a/.github/workflows/triage-pull-requests.yml b/.github/workflows/triage-pull-requests.yml index d1af016cfd07..f83ff5c9e8d5 100644 --- a/.github/workflows/triage-pull-requests.yml +++ b/.github/workflows/triage-pull-requests.yml @@ -1,7 +1,9 @@ name: Triage new pull requests on: pull_request: - types: [reopened, opened] + types: + - reopened + - opened jobs: triage_pulls: @@ -9,14 +11,14 @@ jobs: runs-on: ubuntu-latest steps: - - name: Label new pull requests with 'triage' - uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - add-labels: "triage" - - name: Triage to project board - uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 - with: - action-token: ${{ secrets.GITHUB_TOKEN }} - project-url: "https://github.com/github/docs/projects/1" - column-name: "Triage" + - name: Label new pull requests with 'triage' + uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' + add-labels: 'triage' + - name: Triage to project board + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + with: + action-token: ${{ secrets.GITHUB_TOKEN }} + project-url: 'https://github.com/github/docs/projects/1' + column-name: 'Triage' diff --git a/.github/workflows/triage-stale-check.yml b/.github/workflows/triage-stale-check.yml index 35d4047c2457..4fd8cd8fccf4 100644 --- a/.github/workflows/triage-stale-check.yml +++ b/.github/workflows/triage-stale-check.yml @@ -1,7 +1,7 @@ name: Public Repo Stale Check on: schedule: - - cron: "45 16 * * *" # Run each day at 16:45 UTC / 8:45 PST + - cron: '45 16 * * *' # Run each day at 16:45 UTC / 8:45 PST jobs: stale: @@ -9,12 +9,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - stale-pr-message: 'This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.' - days-before-stale: 7 - days-before-close: 10 - stale-pr-label: 'stale' - exempt-pr-labels: 'never-stale' - exempt-issue-labels: 'never-stale' + - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-pr-message: 'This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.' + days-before-stale: 7 + days-before-close: 10 + stale-pr-label: 'stale' + exempt-pr-labels: 'never-stale' + exempt-issue-labels: 'never-stale' diff --git a/.github/workflows/update-graphql-files.yml b/.github/workflows/update-graphql-files.yml index 670598e176f8..febfcf618c45 100644 --- a/.github/workflows/update-graphql-files.yml +++ b/.github/workflows/update-graphql-files.yml @@ -10,63 +10,64 @@ env: on: schedule: - - cron: "20 16 * * *" # run every day at 16:20 UTC / 8:20 PST + - cron: '20 16 * * *' # run every day at 16:20 UTC / 8:20 PST jobs: update_graphql_files: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: - - if: ${{ env.FREEZE == 'true' }} - run: | - echo 'The repo is currently frozen! Exiting this workflow.' - exit 1 # prevents further steps from running - - name: Checkout - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - name: Set up Ruby - uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526 - with: - ruby-version: '2.4' - - name: Install Ruby dependencies - run: | - gem install bundler - bundle install - - name: Install Node.js dependencies - run: npm ci - - name: Run updater scripts - env: - # need to use a token from a user with access to github/github for this step - GITHUB_TOKEN: ${{ secrets.ZEKE_PAT_WITH_REPO_AND_WORKFLOW_SCOPE_FOR_REPO_SYNC }} - # technically the changelog should only be updated once per day, but we can safely - # run build-changelog-from-markdown.js in its current form once per hour; when we - # rewrite the changelog script, we may need to run it in a separate workflow on a - # once-per-day schedule; see details in https://github.com/github/docs-internal/issues/12722. - run: | - script/graphql/update-files.js - script/graphql/build-changelog-from-markdown.js - - name: Create pull request - id: create-pull-request - uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8 - with: - # need to use a token with repo and workflow scopes for this step - token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - commit-message: 'Action ran graphql scripts "update-files" and "build-changelog-from-markdown"' - title: GraphQL schema update - body: "Hello! Some GraphQL data in github/github was updated recently. This PR - syncs up the GraphQL data in this repo.\n\n - If CI passes, this PR will be auto-merged. :green_heart:\n\n - If CI does not pass or other problems arise, contact #docs-engineering on slack." - labels: automerge - branch: graphql-schema-update - - if: ${{ failure() }} - name: Delete remote branch (if previous steps failed) - uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - branches: graphql-schema-update - - if: ${{ steps.create-pull-request.outputs.pr_number }} - name: Approve - uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - number: ${{ steps.create-pull-request.outputs.pr_number }} + - if: ${{ env.FREEZE == 'true' }} + run: | + echo 'The repo is currently frozen! Exiting this workflow.' + exit 1 # prevents further steps from running + - name: Checkout + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - name: Set up Ruby + uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526 + with: + ruby-version: '2.4' + - name: Install Ruby dependencies + run: | + gem install bundler + bundle install + - name: Install Node.js dependencies + run: npm ci + - name: Run updater scripts + env: + # need to use a token from a user with access to github/github for this step + GITHUB_TOKEN: ${{ secrets.ZEKE_PAT_WITH_REPO_AND_WORKFLOW_SCOPE_FOR_REPO_SYNC }} + # technically the changelog should only be updated once per day, but we can safely + # run build-changelog-from-markdown.js in its current form once per hour; when we + # rewrite the changelog script, we may need to run it in a separate workflow on a + # once-per-day schedule; see details in https://github.com/github/docs-internal/issues/12722. + run: | + script/graphql/update-files.js + script/graphql/build-changelog-from-markdown.js + - name: Create pull request + id: create-pull-request + uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8 + with: + # need to use a token with repo and workflow scopes for this step + token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + commit-message: 'Action ran graphql scripts "update-files" and "build-changelog-from-markdown"' + title: GraphQL schema update + body: + "Hello! Some GraphQL data in github/github was updated recently. This PR + syncs up the GraphQL data in this repo.\n\n + If CI passes, this PR will be auto-merged. :green_heart:\n\n + If CI does not pass or other problems arise, contact #docs-engineering on slack." + labels: automerge + branch: graphql-schema-update + - if: ${{ failure() }} + name: Delete remote branch (if previous steps failed) + uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branches: graphql-schema-update + - if: ${{ steps.create-pull-request.outputs.pr_number }} + name: Approve + uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + number: ${{ steps.create-pull-request.outputs.pr_number }} diff --git a/.github/workflows/yml-lint.yml b/.github/workflows/yml-lint.yml new file mode 100644 index 000000000000..69d665ecdeda --- /dev/null +++ b/.github/workflows/yml-lint.yml @@ -0,0 +1,56 @@ +name: Lint Yaml + +on: + workflow_dispatch: + push: + branches: + - main + pull_request: + branches-ignore: + - translations + +jobs: + see_if_should_skip: + runs-on: ubuntu-latest + + outputs: + should_skip: ${{ steps.skip_check.outputs.should_skip }} + steps: + - id: skip_check + uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289 + with: + cancel_others: 'false' + github_token: ${{ github.token }} + paths: '["**/*.yml", "**/*.yaml", "package*.json", ".github/workflows/yml-lint.yml"]' + + lint: + runs-on: ubuntu-latest + needs: see_if_should_skip + if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} + steps: + - name: Check out repo + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + + - name: Setup node + uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d + with: + node-version: 14.x + + - name: Get npm cache directory + id: npm-cache + run: | + echo "::set-output name=dir::$(npm config get cache)" + + - name: Cache node modules + uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a + with: + path: ${{ steps.npm-cache.outputs.dir }} + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-node- + + - name: Install dependencies + run: npm ci + + - name: Run linter + run: npx prettier -c "**/*.{yml,yaml}" diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 000000000000..2c7f8078b653 --- /dev/null +++ b/.prettierignore @@ -0,0 +1 @@ +translations/ diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 000000000000..ed3defe7094f --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,12 @@ +{ + "overrides": [ + { + "files":[ + "**/*.{yml,yaml}" + ], + "options": { + "singleQuote": true + } + } + ] +} diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md new file mode 100644 index 000000000000..3a8fc3bb8985 --- /dev/null +++ b/content/actions/guides/building-and-testing-ruby.md @@ -0,0 +1,318 @@ +--- +title: Building and testing Ruby +intro: You can create a continuous integration (CI) workflow to build and test your Ruby project. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +### Introduction + +This guide shows you how to create a continuous integration (CI) workflow that builds and tests a Ruby application. If your CI tests pass, you may want to deploy your code or publish a gem. + +### Prerequisites + +We recommend that you have a basic understanding of Ruby, YAML, workflow configuration options, and how to create a workflow file. For more information, see: + +- [Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions) +- [Ruby in 20 minutes](https://www.ruby-lang.org/en/documentation/quickstart/) + +### Starting with the Ruby workflow template + +{% data variables.product.prodname_dotcom %} provides a Ruby workflow template that will work for most Ruby projects. For more information, see the [Ruby workflow template](https://github.com/actions/starter-workflows/blob/master/ci/ruby.yml). + +To get started quickly, add the template to the `.github/workflows` directory of your repository. + +{% raw %} +```yaml +name: Ruby + +on: + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + +jobs: + test: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby + # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby, + # change this to (see https://github.com/ruby/setup-ruby#versioning): + # uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0 + with: + ruby-version: 2.6 + - name: Install dependencies + run: bundle install + - name: Run tests + run: bundle exec rake +``` +{% endraw %} + +### Specifying the Ruby version + +The easiest way to specify a Ruby version is by using the `ruby/setup-ruby` action provided by the Ruby organization on GitHub. The action adds any supported Ruby version to `PATH` for each job run in a workflow. For more information see, the [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby). + +Using either Ruby's `ruby/setup-ruby` action or GitHub's `actions/setup-ruby` action is the recommended way of using Ruby with GitHub Actions because it ensures consistent behavior across different runners and different versions of Ruby. + +The `setup-ruby` action takes a Ruby version as an input and configures that version on the runner. + +{% raw %} +```yaml +steps: +- uses: actions/checkout@v2 +- uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.6 # Not needed with a .ruby-version file +- run: bundle install +- run: bundle exec rake +``` +{% endraw %} + +Alternatively, you can check a `.ruby-version` file into the root of your repository and `setup-ruby` will use the version defined in that file. + +### Testing with multiple versions of Ruby + +You can add a matrix strategy to run your workflow with more than one version of Ruby. For example, you can test your code against the latest patch releases of versions 2.7, 2.6, and 2.5. The 'x' is a wildcard character that matches the latest patch release available for a version. + +{% raw %} +```yaml +strategy: + matrix: + ruby-version: [2.7.x, 2.6.x, 2.5.x] +``` +{% endraw %} + +Each version of Ruby specified in the `ruby-version` array creates a job that runs the same steps. The {% raw %}`${{ matrix.ruby-version }}`{% endraw %} context is used to access the current job's version. For more information about matrix strategies and contexts, see "Workflow syntax for GitHub Actions" and "Context and expression syntax for GitHub Actions." + +The full updated workflow with a matrix strategy could look like this: + +{% raw %} +```yaml +name: Ruby CI + +on: + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + +jobs: + test: + + runs-on: ubuntu-latest + + strategy: + matrix: + ruby-version: [2.7.x, 2.6.x, 2.5.x] + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby ${{ matrix.ruby-version }} + # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby, + # change this to (see https://github.com/ruby/setup-ruby#versioning): + # uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0 + with: + ruby-version: ${{ matrix.ruby-version }} + - name: Install dependencies + run: bundle install + - name: Run tests + run: bundle exec rake +``` +{% endraw %} + +### Installing dependencies with Bundler + +The `setup-ruby` action will automatically install bundler for you. The version is determined by your `gemfile.lock` file. If no version is present in your lockfile, then the latest compatible version will be installed. + +{% raw %} +```yaml +steps: +- uses: actions/checkout@v2 +- uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.6 +- run: bundle install +``` +{% endraw %} + +#### Caching dependencies + +The `setup-ruby` actions provides a method to automatically handle the caching of your gems between runs. + +To enable caching, set the following. + +{% raw %} +```yaml +steps: +- uses: ruby/setup-ruby@v1 + with: + bundler-cache: true +``` +{% endraw %} + +This will configure bundler to install your gems to `vendor/cache`. For each successful run of your workflow, this folder will be cached by Actions and re-downloaded for subsequent workflow runs. A hash of your gemfile.lock and the Ruby version are used as the cache key. If you install any new gems, or change a version, the cache will be invalidated and bundler will do a fresh install. + +**Caching without setup-ruby** + +For greater control over caching, you can use the `actions/cache` Action directly. For more information, see "[Caching dependencies to speed up your workflow](/actions/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows)." + +{% raw %} +```yaml +steps: +- uses: actions/cache@v2 + with: + path: vendor/bundle + key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + ${{ runner.os }}-gems- +- name: Bundle install + run: | + bundle config path vendor/bundle + bundle install --jobs 4 --retry 3 +``` +{% endraw %} + +If you're using a matrix build, you will want to include the matrix variables in your cache key. For example, if you have a matrix strategy for different ruby versions (`matrix.ruby-version`) and different operating systems (`matrix.os`), your workflow steps might look like this: + +{% raw %} +```yaml +steps: +- uses: actions/cache@v2 + with: + path: vendor/bundle + key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}- +- name: Bundle install + run: | + bundle config path vendor/bundle + bundle install --jobs 4 --retry 3 +``` +{% endraw %} + +### Matrix testing your code + +The following example matrix tests all stable releases and head versions of MRI, JRuby and TruffleRuby on Ubuntu and macOS. + +{% raw %} +```yaml +name: Matrix Testing + +on: + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + +jobs: + test: + runs-on: ${{ matrix.os }}-latest + strategy: + fail-fast: false + matrix: + os: [ubuntu, macos] + ruby: [2.5, 2.6, 2.7, head, debug, jruby, jruby-head, truffleruby, truffleruby-head] + continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }} + steps: + - uses: actions/checkout@v2 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby }} + - run: bundle install + - run: bundle exec rake +``` +{% endraw %} + +### Linting your code + +The following example installs `rubocop` and uses it to lint all files. For more information, see [Rubocop](https://github.com/rubocop-hq/rubocop). You can [configure Rubocop](https://docs.rubocop.org/rubocop/configuration.html) to decide on the specific linting rules. + +{% raw %} +```yaml +name: Linting + +on: [push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.6 + - run: bundle install + - name: Rubocop + run: rubocop +``` +{% endraw %} + +### Publishing Gems + +You can configure your workflow to publish your Ruby package to any package registry you'd like when your CI tests pass. + +You can store any access tokens or credentials needed to publish your package using repository secrets. The following example creates and publishes a package to `GitHub Package Registry` and `RubyGems`. + +{% raw %} +```yaml + +name: Ruby Gem + +on: + # Manually publish + workflow_dispatch: + # Alternatively, publish whenever changes are merged to the default branch. + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + +jobs: + build: + name: Build + Publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby 2.6 + uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.6 + - run: bundle install + + - name: Publish to GPR + run: | + mkdir -p $HOME/.gem + touch $HOME/.gem/credentials + chmod 0600 $HOME/.gem/credentials + printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials + gem build *.gemspec + gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem + env: + GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}" + OWNER: ${{ github.repository_owner }} + + - name: Publish to RubyGems + run: | + mkdir -p $HOME/.gem + touch $HOME/.gem/credentials + chmod 0600 $HOME/.gem/credentials + printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials + gem build *.gemspec + gem push *.gem + env: + GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}" +``` +{% endraw %} + diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md index ed16f5d6226c..b428505073c4 100644 --- a/content/actions/guides/index.md +++ b/content/actions/guides/index.md @@ -31,6 +31,7 @@ You can use {% data variables.product.prodname_actions %} to create custom conti {% link_in_list /building-and-testing-nodejs %} {% link_in_list /building-and-testing-powershell %} {% link_in_list /building-and-testing-python %} +{% link_in_list /building-and-testing-ruby %} {% link_in_list /building-and-testing-java-with-maven %} {% link_in_list /building-and-testing-java-with-gradle %} {% link_in_list /building-and-testing-java-with-ant %} diff --git a/content/github/authenticating-to-github/about-anonymized-image-urls.md b/content/github/authenticating-to-github/about-anonymized-image-urls.md index f6a8ca7f11f3..d36acb1003a1 100644 --- a/content/github/authenticating-to-github/about-anonymized-image-urls.md +++ b/content/github/authenticating-to-github/about-anonymized-image-urls.md @@ -8,7 +8,7 @@ versions: free-pro-team: '*' --- -To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image that starts with ```https://camo.githubusercontent.com/``` and hides your browser details and related information from other users. +To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image which hides your browser details and related information from other users. The URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. Anyone who receives your anonymized image URL, directly or indirectly, may view your image. To keep sensitive images private, restrict them to a private network or a server that requires authentication instead of using Camo. diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 264a3a22b0a1..2e5c272ef278 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -1,6 +1,7 @@ --- title: Reviewing your security log intro: You can review the security log for your user account to better understand actions you've performed and actions others have performed that involve you. +miniTocMaxHeadingLevel: 4 redirect_from: - /articles/reviewing-your-security-log versions: @@ -33,218 +34,222 @@ The security log lists all actions performed within the last 90 days{% if curren #### Search based on the action performed {% else %} ### Understanding events in your security log - -Actions listed in your security log are grouped within the following categories: {% endif %} -| Category Name | Description +The events listed in your security log are triggered by your actions. Actions are grouped into the following categories: + +| Category name | Description |------------------|-------------------{% if currentVersion == "free-pro-team@latest" %} -| `account_recovery_token` | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods). -| `billing` | Contains all activities related to your billing information. -| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. -| `marketplace_listing` | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %} -| `oauth_access` | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %} -| `payment_method` | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %} -| `profile_picture` | Contains all activities related to your profile picture. -| `project` | Contains all activities related to project boards. -| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account). -| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %} -| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -| `team` | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %} -| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} -| `user` | Contains all activities related to your account. - -A description of the events within these categories is listed below. +| [`account_recovery_token`](#account_recovery_token-category-actions) | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods). +| [`billing`](#billing-category-actions) | Contains all activities related to your billing information. +| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. +| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %} +| [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %} +| [`payment_method`](#payment_method-category-actions) | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %} +| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your profile picture. +| [`project`](#project-category-actions) | Contains all activities related to project boards. +| [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account). +| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %} +| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} +| [`user`](#user-category-actions) | Contains all activities related to your account. + +{% if currentVersion == "free-pro-team@latest" %} + +### Exporting your security log + +{% data reusables.audit_log.export-log %} +{% data reusables.audit_log.exported-log-keys-and-values %} + +{% endif %} + +### Security log actions + +An overview of some of the most common actions that are recorded as events in the security log. {% if currentVersion == "free-pro-team@latest" %} -#### The `account_recovery_token` category +#### `account_recovery_token` category actions | Action | Description |------------------|------------------- -| confirm | Triggered when you successfully [store a new token with a recovery provider](/articles/configuring-two-factor-authentication-recovery-methods). -| recover | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials). -| recover_error | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it. +| `confirm` | Triggered when you successfully [store a new token with a recovery provider](/articles/configuring-two-factor-authentication-recovery-methods). +| `recover` | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials). +| `recover_error` | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it. -#### The `billing` category +#### `billing` category actions | Action | Description |------------------|------------------- -| change_billing_type | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}. -| change_email | Triggered when you [change your email address](/articles/changing-your-primary-email-address). +| `change_billing_type` | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}. +| `change_email` | Triggered when you [change your email address](/articles/changing-your-primary-email-address). -#### The `marketplace_agreement_signature` category +#### `marketplace_agreement_signature` category actions | Action | Description |------------------|------------------- -| create | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. +| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. -#### The `marketplace_listing` category +#### `marketplace_listing` category actions | Action | Description |------------------|------------------- -| approve | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}. -| create | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}. -| delist | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}. -| redraft | Triggered when your listing is sent back to draft state. -| reject | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}. +| `approve` | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}. +| `create` | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}. +| `delist` | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}. +| `redraft` | Triggered when your listing is sent back to draft state. +| `reject` | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}. {% endif %} -#### The `oauth_access` category +#### `oauth_access` category actions | Action | Description |------------------|------------------- -| create | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/articles/authorizing-oauth-apps). -| destroy | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations). +| `create` | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/articles/authorizing-oauth-apps). +| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations). {% if currentVersion == "free-pro-team@latest" %} -#### The `payment_method` category +#### `payment_method` category actions | Action | Description |------------------|------------------- -| clear | Triggered when [a payment method](/articles/removing-a-payment-method) on file is removed. -| create | Triggered when a new payment method is added, such as a new credit card or PayPal account. -| update | Triggered when an existing payment method is updated. +| `clear` | Triggered when [a payment method](/articles/removing-a-payment-method) on file is removed. +| `create` | Triggered when a new payment method is added, such as a new credit card or PayPal account. +| `update` | Triggered when an existing payment method is updated. {% endif %} -#### The `profile_picture` category +#### `profile_picture` category actions | Action | Description |------------------|------------------- -| update | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/). +| `update` | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/). -#### The `project` category +#### `project` category actions | Action | Description |--------------------|--------------------- +| `access` | Triggered when a project board's visibility is changed. | `create` | Triggered when a project board is created. | `rename` | Triggered when a project board is renamed. | `update` | Triggered when a project board is updated. | `delete` | Triggered when a project board is deleted. | `link` | Triggered when a repository is linked to a project board. | `unlink` | Triggered when a repository is unlinked from a project board. -| `project.access` | Triggered when a project board's visibility is changed. | `update_user_permission` | Triggered when an outside collaborator is added to or removed from a project board or has their permission level changed. -#### The `public_key` category +#### `public_key` category actions | Action | Description |------------------|------------------- -| create | Triggered when you [add a new public SSH key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). -| delete | Triggered when you [remove a public SSH key to your {% data variables.product.product_name %} account](/articles/reviewing-your-ssh-keys). +| `create` | Triggered when you [add a new public SSH key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). +| `delete` | Triggered when you [remove a public SSH key to your {% data variables.product.product_name %} account](/articles/reviewing-your-ssh-keys). -#### The `repo` category +#### `repo` category actions | Action | Description |------------------|------------------- -| access | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa). -| add_member | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository. -| add_topic | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository. -| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -| config.disable_anonymous_git_access | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. -| config.enable_anonymous_git_access | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. -| config.lock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). -| config.unlock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} -| create | Triggered when [a new repository is created](/articles/creating-a-new-repository). -| destroy | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %} -| disable | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| enable | Triggered when a repository is re-enabled.{% endif %} -| remove_member | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository). -| remove_topic | Triggered when a repository owner removes a topic from a repository. -| rename | Triggered when [a repository is renamed](/articles/renaming-a-repository). -| transfer | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). -| transfer_start | Triggered when a repository transfer is about to occur. -| unarchived | Triggered when a repository owner unarchives a repository. +| `access` | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa). +| `add_member` | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository. +| `add_topic` | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository. +| `archived` | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). +| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} +| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository). +| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %} +| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| `enable` | Triggered when a repository is re-enabled.{% endif %} +| `remove_member` | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository). +| `remove_topic` | Triggered when a repository owner removes a topic from a repository. +| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository). +| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). +| `transfer_start` | Triggered when a repository transfer is about to occur. +| `unarchived` | Triggered when a repository owner unarchives a repository. {% if currentVersion == "free-pro-team@latest" %} -#### The `sponsors` category +#### `sponsors` category actions | Action | Description |------------------|------------------- -| repo_funding_link_button_toggle | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") -| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") -| sponsor_sponsorship_cancel | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| sponsor_sponsorship_create | Triggered when you sponsor a developer (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor#sponsoring-a-developer)") -| sponsor_sponsorship_preference_change | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") -| sponsor_sponsorship_tier_change | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| sponsored_developer_approve | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| sponsored_developer_create | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| sponsored_developer_profile_update | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| sponsored_developer_request_approval | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| sponsored_developer_tier_description_update | Triggered when you change the description for a sponsorship tier (see "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)") -| sponsored_developer_update_newsletter_send | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") -| waitlist_invite_sponsored_developer | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| waitlist_join | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `repo_funding_link_button_toggle` | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor a developer (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor#sponsoring-a-developer)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") +| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") {% endif %} {% if currentVersion == "free-pro-team@latest" %} -#### The `successor_invitation` category +#### `successor_invitation` category actions | Action | Description |------------------|------------------- -| accept | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| cancel | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| create | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| decline | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| revoke | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") {% endif %} {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -#### The `team` category +#### `team` category actions | Action | Description |------------------|------------------- -| add_member | Triggered when a member of an organization you belong to [adds you to a team](/articles/adding-organization-members-to-a-team). -| add_repository | Triggered when a team you are a member of is given control of a repository. -| create | Triggered when a new team in an organization you belong to is created. -| destroy | Triggered when a team you are a member of is deleted from the organization. -| remove_member | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team) you are a member of. -| remove_repository | Triggered when a repository is no longer under a team's control. +| `add_member` | Triggered when a member of an organization you belong to [adds you to a team](/articles/adding-organization-members-to-a-team). +| `add_repository` | Triggered when a team you are a member of is given control of a repository. +| `create` | Triggered when a new team in an organization you belong to is created. +| `destroy` | Triggered when a team you are a member of is deleted from the organization. +| `remove_member` | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team) you are a member of. +| `remove_repository` | Triggered when a repository is no longer under a team's control. {% endif %} {% if currentVersion != "github-ae@latest" %} -#### The `two_factor_authentication` category +#### `two_factor_authentication` category actions | Action | Description |------------------|------------------- -| enabled | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled. -| disabled | Triggered when two-factor authentication is disabled. +| `enabled` | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled. +| `disabled` | Triggered when two-factor authentication is disabled. {% endif %} -#### The `user` category +#### `user` category actions | Action | Description |--------------------|--------------------- -| add_email | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}. -| create | Triggered when you create a new user account. -| remove_email | Triggered when you remove an email address. -| rename | Triggered when you rename your account.{% if currentVersion != "github-ae@latest" %} -| change_password | Triggered when you change your password. -| forgot_password | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %} -| login | Triggered when you log in to {% data variables.product.product_location %}. -| failed_login | Triggered when you failed to log in successfully.{% if currentVersion != "github-ae@latest" %} -| two_factor_requested | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %} -| show_private_contributions_count | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). -| hide_private_contributions_count | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion == "free-pro-team@latest" %} -| report_content | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %} - -#### The `user_status` category +| `add_email` | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}. +| `create` | Triggered when you create a new user account.{% if currentVersion != "github-ae@latest" %} +| `change_password` | Triggered when you change your password. +| `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %} +| `hide_private_contributions_count` | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). +| `login` | Triggered when you log in to {% data variables.product.product_location %}. +| `failed_login` | Triggered when you failed to log in successfully. +| `remove_email` | Triggered when you remove an email address. +| `rename` | Triggered when you rename your account.{% if currentVersion == "free-pro-team@latest" %} +| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %} +| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion != "github-ae@latest" %} +| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %} + +#### `user_status` category actions | Action | Description |--------------------|--------------------- -| update | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)." -| destroy | Triggered when you clear the status on your profile. - -{% if currentVersion == "free-pro-team@latest" %} +| `update` | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)." +| `destroy` | Triggered when you clear the status on your profile. -### Exporting your security log -{% data reusables.audit_log.export-log %} -{% data reusables.audit_log.exported-log-keys-and-values %} - -{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md index 61497be9a9dd..12d028716278 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md @@ -1,6 +1,7 @@ --- title: Reviewing the audit log for your organization intro: 'The audit log allows organization admins to quickly review the actions performed by members of your organization. It includes details such as who performed the action, what the action was, and when it was performed.' +miniTocMaxHeadingLevel: 4 redirect_from: - /articles/reviewing-the-audit-log-for-your-organization versions: @@ -11,7 +12,7 @@ versions: ### Accessing the audit log -The audit log lists actions performed within the last 90 days. Only owners can access an organization's audit log. +The audit log lists events triggered by activities that affect your organization within the last 90 days. Only owners can access an organization's audit log. {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} @@ -26,73 +27,110 @@ The audit log lists actions performed within the last 90 days. Only owners can a To search for specific events, use the `action` qualifier in your query. Actions listed in the audit log are grouped within the following categories: -| Category Name | Description +| Category name | Description |------------------|-------------------{% if currentVersion == "free-pro-team@latest" %} -| `account` | Contains all activities related to your organization account.{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| `billing` | Contains all activities related to your organization's billing.{% endif %} -| `discussion_post` | Contains all activities related to discussions posted to a team page. -| `discussion_post_reply` | Contains all activities related to replies to discussions posted to a team page. -| `hook` | Contains all activities related to webhooks. -| `integration_installation_request` | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. |{% if currentVersion == "free-pro-team@latest" %} -| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. -| `marketplace_listing` | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -| `members_can_create_pages` | Contains all activities related to disabling the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Restricting publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)." | {% endif %} -| `org` | Contains all activities related to organization membership{% if currentVersion == "free-pro-team@latest" %} -| `org_credential_authorization` | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} -| `organization_label` | Contains all activities related to default labels for repositories in your organization.{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| `payment_method` | Contains all activities related to how your organization pays for GitHub.{% endif %} -| `profile_picture` | Contains all activities related to your organization's profile picture. -| `project` | Contains all activities related to project boards. -| `protected_branch` | Contains all activities related to protected branches. -| `repo` | Contains all activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %} -| `repository_content_analysis` | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data). -| `repository_dependency_graph` | Contains all activities related to [enabling or disabling the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).{% endif %}{% if currentVersion != "github-ae@latest" %} -| `repository_vulnerability_alert` | Contains all activities related to [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| `sponsors` | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -| `team` | Contains all activities related to teams in your organization.{% endif %} -| `team_discussions` | Contains activities related to managing team discussions for an organization. +| [`account`](#account-category-actions) | Contains all activities related to your organization account. +| [`advisory_credit`](#advisory_credit-category-actions) | Contains all activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. +| [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." +| [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization. +| [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| [`dependency_graph_new_repos`](#dependency_graph_new_repos-category-actions) | Contains organization-level configuration activities for new repositories created in the organization.{% endif %} +| [`discussion_post`](#discussion_post-category-actions) | Contains all activities related to discussions posted to a team page. +| [`discussion_post_reply`](#discussion_post_reply-category-actions) | Contains all activities related to replies to discussions posted to a team page. +| [`hook`](#hook-category-actions) | Contains all activities related to webhooks. +| [`integration_installation_request`](#integration_installation_request-category-actions) | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. | +| [`issue`](#issue-category-actions) | Contains activities related to deleting an issue. {% if currentVersion == "free-pro-team@latest" %} +| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. +| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to disabling the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Restricting publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)." | {% endif %} +| [`org`](#org-category-actions) | Contains activities related to organization membership.{% if currentVersion == "free-pro-team@latest" %} +| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} +| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.{% endif %} +| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps. {% if currentVersion == "free-pro-team@latest" %} +| [`payment_method`](#payment_method-category-actions) | Contains all activities related to how your organization pays for GitHub.{% endif %} +| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your organization's profile picture. +| [`project`](#project-category-actions) | Contains all activities related to project boards. +| [`protected_branch`](#protected_branch-category-actions) | Contains all activities related to protected branches. +| [`repo`](#repo-category-actions) | Contains activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %} +| [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% if currentVersion != "github-ae@latest" %} +| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% if currentVersion != "github-ae@latest" %} +| [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% if currentVersion == "free-pro-team@latest" %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +| [`team`](#team-category-actions) | Contains all activities related to teams in your organization.{% endif %} +| [`team_discussions`](#team_discussions-category-actions) | Contains activities related to managing team discussions for an organization. You can search for specific sets of actions using these terms. For example: * `action:team` finds all events grouped within the team category. * `-action:hook` excludes all events in the webhook category. -Each category has a set of associated events that you can filter on. For example: +Each category has a set of associated actions that you can filter on. For example: * `action:team.create` finds all events where a team was created. * `-action:hook.events_changed` excludes all events where the events on a webhook have been altered. -This list describes the available categories and associated events: - -{% if currentVersion == "free-pro-team@latest" %}- [The `account` category](#the-account-category) -- [The `billing` category](#the-billing-category){% endif %} -- [The `discussion_post` category](#the-discussion_post-category) -- [The `discussion_post_reply` category](#the-discussion_post_reply-category) -- [The `hook` category](#the-hook-category) -- [The `integration_installation_request` category](#the-integration_installation_request-category) -- [The `issue` category](#the-issue-category){% if currentVersion == "free-pro-team@latest" %} -- [The `marketplace_agreement_signature` category](#the-marketplace_agreement_signature-category) -- [The `marketplace_listing` category](#the-marketplace_listing-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -- [The `members_can_create_pages` category](#the-members_can_create_pages-category){% endif %} -- [The `org` category](#the-org-category){% if currentVersion == "free-pro-team@latest" %} -- [The `org_credential_authorization` category](#the-org_credential_authorization-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} -- [The `organization_label` category](#the-organization_label-category){% endif %} -- [The `oauth_application` category](#the-oauth_application-category){% if currentVersion == "free-pro-team@latest" %} -- [The `payment_method` category](#the-payment_method-category){% endif %} -- [The `profile_picture` category](#the-profile_picture-category) -- [The `project` category](#the-project-category) -- [The `protected_branch` category](#the-protected_branch-category) -- [The `repo` category](#the-repo-category){% if currentVersion == "free-pro-team@latest" %} -- [The `repository_content_analysis` category](#the-repository_content_analysis-category) -- [The `repository_dependency_graph` category](#the-repository_dependency_graph-category){% endif %}{% if currentVersion != "github-ae@latest" %} -- [The `repository_vulnerability_alert` category](#the-repository_vulnerability_alert-category){% endif %}{% if currentVersion == "free-pro-team@latest" %} -- [The `sponsors` category](#the-sponsors-category){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -- [The `team` category](#the-team-category){% endif %} -- [The `team_discussions` category](#the-team_discussions-category) +#### Search based on time of action + +Use the `created` qualifier to filter events in the audit log based on when they occurred. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} + +{% data reusables.search.date_gt_lt %} For example: + + * `created:2014-07-08` finds all events that occurred on July 8th, 2014. + * `created:>=2014-07-08` finds all events that occurred on or after July 8th, 2014. + * `created:<=2014-07-08` finds all events that occurred on or before July 8th, 2014. + * `created:2014-07-01..2014-07-31` finds all events that occurred in the month of July 2014. + +The audit log contains data for the past 90 days, but you can use the `created` qualifier to search for events earlier than that. + +#### Search based on location + +Using the qualifier `country`, you can filter events in the audit log based on the originating country. You can use a country's two-letter short code or its full name. Keep in mind that countries with spaces in their name will need to be wrapped in quotation marks. For example: + + * `country:de` finds all events that occurred in Germany. + * `country:Mexico` finds all events that occurred in Mexico. + * `country:"United States"` all finds events that occurred in the United States. {% if currentVersion == "free-pro-team@latest" %} +### Exporting the audit log + +{% data reusables.audit_log.export-log %} +{% data reusables.audit_log.exported-log-keys-and-values %} +{% endif %} + +### Using the Audit log API + +{% note %} -##### The `account` category +**Note**: The Audit log API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %} + +{% endnote %} + +To ensure a secure IP and maintain compliance for your organization, you can use the Audit log API to keep copies of your audit log data and monitor: +* Access to your organization or repository settings. +* Changes in permissions. +* Added or removed users in an organization, repository, or team. +* Users being promoted to admin. +* Changes to permissions of a GitHub App. + +The GraphQL response can include data for up to 90 to 120 days. + +For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)." + +### Audit log actions + +An overview of some of the most common actions that are recorded as events in the audit log. + +{% if currentVersion == "free-pro-team@latest" %} + +#### `account` category actions | Action | Description |------------------|------------------- @@ -101,30 +139,81 @@ This list describes the available categories and associated events: | `pending_plan_change` | Triggered when an organization owner or billing manager [cancels or downgrades a paid subscription](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process/). | `pending_subscription_change` | Triggered when a [{% data variables.product.prodname_marketplace %} free trial starts or expires](/articles/about-billing-for-github-marketplace/). -##### The `billing` category +#### `advisory_credit` category actions + +| Action | Description +|------------------|------------------- +| `accept` | Triggered when someone accepts credit for a security advisory. For more information, see "[Editing a security advisory](/github/managing-security-vulnerabilities/editing-a-security-advisory)." +| `create` | Triggered when the administrator of a security advisory adds someone to the credit section. +| `decline` | Triggered when someone declines credit for a security advisory. +| `destroy` | Triggered when the administrator of a security advisory removes someone from the credit section. + +#### `billing` category actions | Action | Description |------------------|------------------- | `change_billing_type` | Triggered when your organization [changes how it pays for {% data variables.product.prodname_dotcom %}](/articles/adding-or-editing-a-payment-method). | `change_email` | Triggered when your organization's [billing email address](/articles/setting-your-billing-email) changes. +#### `dependabot_alerts` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all existing {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all existing {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + +#### `dependabot_alerts_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enbles {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + +#### `dependabot_security_updates` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. + +#### `dependabot_security_updates_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. + +#### `dependency_graph` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all existing repositories. + +#### `dependency_graph_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all new repositories. + {% endif %} -##### The `discussion_post` category +#### `discussion_post` category actions | Action | Description |------------------|------------------- | `update` | Triggered when [a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). | `destroy` | Triggered when [a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). -##### The `discussion_post_reply` category +#### `discussion_post_reply` category actions | Action | Description |------------------|------------------- | `update` | Triggered when [a reply to a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). | `destroy` | Triggered when [a reply to a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). -##### The `hook` category +#### `hook` category actions | Action | Description |------------------|------------------- @@ -133,14 +222,14 @@ This list describes the available categories and associated events: | `destroy` | Triggered when an existing hook was removed from a repository. | `events_changed` | Triggered when the events on a hook have been altered. -##### The `integration_installation_request` category +#### `integration_installation_request` category actions | Action | Description |------------------|------------------- | `create` | Triggered when an organization member requests that an organization owner install an integration for use in the organization. | `close` | Triggered when a request to install an integration for use in an organization is either approved or denied by an organization owner, or canceled by the organization member who opened the request. -##### The `issue` category +#### `issue` category actions | Action | Description |------------------|------------------- @@ -148,13 +237,13 @@ This list describes the available categories and associated events: {% if currentVersion == "free-pro-team@latest" %} -##### The `marketplace_agreement_signature` category +#### `marketplace_agreement_signature` category actions | Action | Description |------------------|------------------- | `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. -##### The `marketplace_listing` category +#### `marketplace_listing` category actions | Action | Description |------------------|------------------- @@ -168,7 +257,7 @@ This list describes the available categories and associated events: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -##### The `members_can_create_pages` category +#### `members_can_create_pages` category actions For more information, see "[Restricting publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)." @@ -179,7 +268,7 @@ For more information, see "[Restricting publication of {% data variables.product {% endif %} -##### The `org` category +#### `org` category actions | Action | Description |------------------|-------------------{% if currentVersion == "free-pro-team@latest"%} @@ -222,7 +311,7 @@ For more information, see "[Restricting publication of {% data variables.product | `update_terms_of_service` | Triggered when an organization changes between the Standard Terms of Service and the Corporate Terms of Service. For more information, see "[Upgrading to the Corporate Terms of Service](/articles/upgrading-to-the-corporate-terms-of-service)."{% endif %} {% if currentVersion == "free-pro-team@latest" %} -##### The `org_credential_authorization` category +#### `org_credential_authorization` category actions | Action | Description |------------------|------------------- @@ -233,7 +322,7 @@ For more information, see "[Restricting publication of {% data variables.product {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} -##### The `organization_label` category +#### `organization_label` category actions | Action | Description |------------------|------------------- @@ -243,7 +332,7 @@ For more information, see "[Restricting publication of {% data variables.product {% endif %} -##### The `oauth_application` category +#### `oauth_application` category actions | Action | Description |------------------|------------------- @@ -255,7 +344,7 @@ For more information, see "[Restricting publication of {% data variables.product {% if currentVersion == "free-pro-team@latest" %} -##### The `payment_method` category +#### `payment_method` category actions | Action | Description |------------------|------------------- @@ -265,12 +354,12 @@ For more information, see "[Restricting publication of {% data variables.product {% endif %} -##### The `profile_picture` category +#### `profile_picture` category actions | Action | Description |------------------|------------------- | update | Triggered when you set or update your organization's profile picture. -##### The `project` category +#### `project` category actions | Action | Description |--------------------|--------------------- @@ -284,7 +373,7 @@ For more information, see "[Restricting publication of {% data variables.product | `update_team_permission` | Triggered when a team's project board permission level is changed or when a team is added or removed from a project board. | | `update_user_permission` | Triggered when an organization member or outside collaborator is added to or removed from a project board or has their permission level changed.| -##### The `protected_branch` category +#### `protected_branch` category actions | Action | Description |--------------------|--------------------- @@ -304,7 +393,7 @@ For more information, see "[Restricting publication of {% data variables.product | `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch. {% endif %} -##### The `repo` category +#### `repo` category actions | Action | Description |------------------|------------------- @@ -334,34 +423,80 @@ For more information, see "[Restricting publication of {% data variables.product {% if currentVersion == "free-pro-team@latest" %} -##### The `repository_content_analysis` category +#### `repository_advisory` category actions + +| Action | Description +|------------------|------------------- +| `close` | Triggered when someone closes a security advisory. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| `cve_request` | Triggered when someone requests a CVE (Common Vulnerabilities and Exposures) number from {% data.variables.product.prodname_dotcom %} for a draft security advisory. +| `github_broadcast` | Triggered when {% data.variables.product.prodname_dotcom %} makes a security advisory public in the {% data variables.product.prodname_advisory_database %}. +| `github_withdraw` | Triggered when {% data.variables.product.prodname_dotcom %} withdraws a security advisory that was published in error. +| `open` | Triggered when someone opens a draft security advisory. +| `publish` | Triggered when someone publishes a security advisory. +| `reopen` | Triggered when someone reopens as draft security advisory. +| `update` | Triggered when someone edits a draft or published security advisory. + +#### `repository_content_analysis` category actions | Action | Description |------------------|------------------- | `enable` | Triggered when an organization owner or person with admin access to the repository [enables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). | `disable` | Triggered when an organization owner or person with admin access to the repository [disables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). -##### The `repository_dependency_graph` category +{% endif %}{% if currentVersion != "github-ae@latest" %} + +#### `repository_dependency_graph` category actions | Action | Description |------------------|------------------- -| `enable` | Triggered when a repository owner or person with admin access to the repository [enables the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository). -| `disable` | Triggered when a repository owner or person with admin access to the repository [disables the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository). +| `disable` | Triggered when a repository owner or person with admin access to the repository disables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. -{% endif %} -{% if currentVersion != "github-ae@latest" %} -##### The `repository_vulnerability_alert` category +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +#### `repository_secret_scanning` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when a repository owner or person with admin access to the repository disables secret scanning for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables secret scanning for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. + +{% endif %}{% if currentVersion != "github-ae@latest" %} +#### `repository_vulnerability_alert` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when {% data variables.product.product_name %} creates a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency. +| `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. + +{% endif %}{% if currentVersion == "free-pro-team@latest" %} +#### `repository_vulnerability_alerts` category actions + +| Action | Description +|------------------|------------------- +| `authorized_users_teams` | Triggered when an organization owner or a person with admin permissions to the repository updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies in the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-dependabot-alerts)." +| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. +| `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. + +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +#### `secret_scanning` category actions | Action | Description |------------------|------------------- -| `create` | Triggered when {% data variables.product.product_name %} creates a [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a vulnerable dependency](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a particular repository. -| `resolve` | Triggered when someone with write access to a repository [pushes changes to update and resolve a vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a project dependency. -| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency.{% if currentVersion == "free-pro-team@latest" %} -| `authorized_users_teams` | Triggered when an organization owner or a member with admin permissions to the repository [updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-dependabot-alerts) for vulnerable dependencies in the repository.{% endif %} +| `disable` | Triggered when an organization owner disables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. + +#### `secret_scanning_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables secret scanning for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + {% endif %} {% if currentVersion == "free-pro-team@latest" %} -##### The `sponsors` category +#### `sponsors` category actions | Action | Description |------------------|------------------- @@ -370,7 +505,7 @@ For more information, see "[Restricting publication of {% data variables.product {% endif %} {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} -##### The `team` category +#### `team` category actions | Action | Description |------------------|------------------- @@ -384,60 +519,13 @@ For more information, see "[Restricting publication of {% data variables.product | `remove_repository` | Triggered when a repository is no longer under a team's control. {% endif %} -##### The `team_discussions` category +#### `team_discussions` category actions | Action | Description |---|---| | `disable` | Triggered when an organization owner disables team discussions for an organization. For more information, see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)." | `enable` | Triggered when an organization owner enables team discussions for an organization. -#### Search based on time of action - -Use the `created` qualifier to filter actions in the audit log based on when they occurred. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} - -{% data reusables.search.date_gt_lt %} For example: - - * `created:2014-07-08` finds all events that occurred on July 8th, 2014. - * `created:>=2014-07-08` finds all events that occurred on or after July 8th, 2014. - * `created:<=2014-07-08` finds all events that occurred on or before July 8th, 2014. - * `created:2014-07-01..2014-07-31` finds all events that occurred in the month of July 2014. - -The audit log contains data for the past 90 days, but you can use the `created` qualifier to search for events earlier than that. - -#### Search based on location - -Using the qualifier `country`, you can filter actions in the audit log based on the originating country. You can use a country's two-letter short code or its full name. Keep in mind that countries with spaces in their name will need to be wrapped in quotation marks. For example: - - * `country:de` finds all events that occurred in Germany. - * `country:Mexico` finds all events that occurred in Mexico. - * `country:"United States"` all finds events that occurred in the United States. - -{% if currentVersion == "free-pro-team@latest" %} -### Exporting the audit log - -{% data reusables.audit_log.export-log %} -{% data reusables.audit_log.exported-log-keys-and-values %} -{% endif %} - -### Using the Audit log API - -{% note %} - -**Note**: The Audit log API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %} - -{% endnote %} - -To ensure a secure IP and maintain compliance for your organization, you can use the Audit log API to keep copies of your audit log data and monitor: -* Access to your organization or repository settings. -* Changes in permissions. -* Added or removed users in an organization, repository, or team. -* Users being promoted to admin. -* Changes to permissions of a GitHub App. - -The GraphQL response can include data for up to 90 to 120 days. - -For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)." - ### Further reading - "[Keeping your organization secure](/articles/keeping-your-organization-secure)" diff --git a/content/rest/reference/search.md b/content/rest/reference/search.md index 79f4b76b8765..baf050224359 100644 --- a/content/rest/reference/search.md +++ b/content/rest/reference/search.md @@ -36,7 +36,7 @@ Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: ``` -q=SEARCH_KEYWORD_1+SEARCH_KEYWORD_N+QUALIFIER_1+QUALIFIER_N +SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` For example, if you wanted to search for all _repositories_ owned by `defunkt` that @@ -44,7 +44,13 @@ contained the word `GitHub` and `Octocat` in the README file, you would use the following query with the _search repositories_ endpoint: ``` -q=GitHub+Octocat+in:readme+user:defunkt +GitHub Octocat in:readme user:defunkt +``` + +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: +```javascript +// JavaScript +const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` See "[Searching on GitHub](/articles/searching-on-github/)" diff --git a/crowdin.yml b/crowdin.yml index ef80b4ec26fe..2dbc3886af9f 100644 --- a/crowdin.yml +++ b/crowdin.yml @@ -1,25 +1,23 @@ files: - source: /content/**/*.md translation: /translations/%locale%/%original_path%/%original_file_name% - ignore: [ - "/content/README.md" - ] + ignore: + - '/content/README.md' - source: /data/**/*.yml translation: /translations/%locale%/%original_path%/%original_file_name% - source: /data/**/*.md translation: /translations/%locale%/%original_path%/%original_file_name% - ignore: [ - "data/README.md", - "data/reusables/README.md", - "data/variables/product.yml", - "data/variables/README.md", - "data/graphql", - "data/products.yml" - ] + ignore: + - 'data/README.md' + - 'data/reusables/README.md' + - 'data/variables/product.yml' + - 'data/variables/README.md' + - 'data/graphql' + - 'data/products.yml' # These end up as env vars used by the GitHub Actions workflow project_id_env: CROWDIN_PROJECT_ID api_token_env: CROWDIN_PERSONAL_TOKEN # https://support.crowdin.com/configuration-file-v3/#saving-directory-structure-on-server -preserve_hierarchy: true \ No newline at end of file +preserve_hierarchy: true diff --git a/data/glossaries/external.yml b/data/glossaries/external.yml index ab095361f6b2..e8613797ebc0 100644 --- a/data/glossaries/external.yml +++ b/data/glossaries/external.yml @@ -1,5 +1,6 @@ - term: '@mention' - description: to notify a person on GitHub by using `@` before their username. Users in an organization on GitHub can also be a part of a team that can be + description: + to notify a person on GitHub by using `@` before their username. Users in an organization on GitHub can also be a part of a team that can be mentioned. - term: access token description: >- @@ -26,7 +27,8 @@ with 2FA via the browser. This code is either generated by an application or delivered to your phone via text message. Also called a "2FA authentication code." - term: base branch - description: The branch into which changes are combined when you merge a pull request. + description: + The branch into which changes are combined when you merge a pull request. When you create a pull request, you can change the base branch from the repository's default branch to another branch if required. - term: basic authentication description: >- @@ -300,7 +302,7 @@ description: A defined commit of a branch, usually the most recent commit at the tip of the branch. - term: head branch description: The branch whose changes are combined into the base branch - when you merge a pull request. + when you merge a pull request. Also known as the "compare branch." - term: 'Hello, World' description: >- diff --git a/data/graphql/ghae/graphql_previews.ghae.yml b/data/graphql/ghae/graphql_previews.ghae.yml index c17115e10c1b..7efae641792d 100644 --- a/data/graphql/ghae/graphql_previews.ghae.yml +++ b/data/graphql/ghae/graphql_previews.ghae.yml @@ -83,7 +83,7 @@ toggled_on: - Mutation.createContentAttachment owning_teams: - - '@github/ce-extensibility' + - '@github/feature-lifecycle' - title: Pinned Issues Preview description: This preview adds support for pinned issues. toggled_by: ':elektra-preview' diff --git a/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml b/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml index 56e1ff90ea8f..777f9f415863 100644 --- a/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml +++ b/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml @@ -1,106 +1,114 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: EnterpriseBillingInfo.availableSeats - description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses - instead." - reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide - more clarity on the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: EnterpriseBillingInfo.seats - description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead." - reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on - the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: Sponsorship.maintainer - description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead." - reason: "`Sponsorship.maintainer` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: EnterprisePendingMemberInvitationEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending members consume a license - date: '2020-07-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOwnerInfo.pendingCollaborators - description: "`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` - field instead." - reason: Repository invitations can now be associated with an email, not only an - invitee. - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: RepositoryInvitationOrderField.INVITEE_LOGIN - description: "`INVITEE_LOGIN` will be removed." - reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations - can now be associated with an email, not only an invitee." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Sponsorship.sponsor - description: "`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead." - reason: "`Sponsorship.sponsor` will be removed." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: nholden -- location: EnterpriseMemberEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All members consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOutsideCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All outside collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterprisePendingCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: MergeStateStatus.DRAFT - description: "`DRAFT` will be removed. Use PullRequest.isDraft instead." - reason: DRAFT state will be removed from this enum and `isDraft` should be used - instead - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: nplasterer + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: EnterpriseBillingInfo.availableSeats + description: + '`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses + instead.' + reason: + '`availableSeats` will be replaced with `totalAvailableLicenses` to provide + more clarity on the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: EnterpriseBillingInfo.seats + description: '`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead.' + reason: + '`seats` will be replaced with `totalLicenses` to provide more clarity on + the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: Sponsorship.maintainer + description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' + reason: '`Sponsorship.maintainer` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: EnterprisePendingMemberInvitationEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending members consume a license + date: '2020-07-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOwnerInfo.pendingCollaborators + description: + '`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` + field instead.' + reason: + Repository invitations can now be associated with an email, not only an + invitee. + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: RepositoryInvitationOrderField.INVITEE_LOGIN + description: '`INVITEE_LOGIN` will be removed.' + reason: + '`INVITEE_LOGIN` is no longer a valid field value. Repository invitations + can now be associated with an email, not only an invitee.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Sponsorship.sponsor + description: '`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead.' + reason: '`Sponsorship.sponsor` will be removed.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: nholden + - location: EnterpriseMemberEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All members consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOutsideCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All outside collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterprisePendingCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: MergeStateStatus.DRAFT + description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.' + reason: + DRAFT state will be removed from this enum and `isDraft` should be used + instead + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: nplasterer diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 7bca3e6574b3..5d1851e1ce68 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -1757,6 +1757,11 @@ enum CheckConclusionState { """ STALE + """ + The check suite or run has failed at startup. + """ + STARTUP_FAILURE + """ The check suite or run has succeeded. """ @@ -6584,6 +6589,11 @@ enum DeploymentState { The deployment has queued """ QUEUED + + """ + The deployment is waiting. + """ + WAITING } """ @@ -10836,6 +10846,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ @@ -11427,6 +11442,31 @@ type IssueCommentEdge { node: IssueComment } +""" +Ways in which lists of issue comments can be ordered upon return. +""" +input IssueCommentOrder { + """ + The direction in which to order issue comments by the specified field. + """ + direction: OrderDirection! + + """ + The field in which to order issue comments by. + """ + field: IssueCommentOrderField! +} + +""" +Properties by which issue comment connections can be ordered. +""" +enum IssueCommentOrderField { + """ + Order issue comments by update time + """ + UPDATED_AT +} + """ The connection type for Issue. """ @@ -12434,12 +12474,12 @@ input LockLockableInput { clientMutationId: String """ - A reason for why the issue or pull request will be locked. + A reason for why the item will be locked. """ lockReason: LockReason """ - ID of the issue or pull request to be locked. + ID of the item to be locked. """ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") } @@ -20277,6 +20317,11 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ @@ -29978,7 +30023,7 @@ type Sponsorship implements Node { sponsor: User @deprecated(reason: "`Sponsorship.sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead. Removal on 2020-10-01 UTC.") """ - The user or organization that is sponsoring. Returns null if the sponsorship is private. + The user or organization that is sponsoring, if you have permission to view them. """ sponsorEntity: Sponsor @@ -33172,7 +33217,7 @@ input UnlockLockableInput { clientMutationId: String """ - ID of the issue or pull request to be unlocked. + ID of the item to be unlocked. """ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") } @@ -35489,6 +35534,11 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryOwne Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ diff --git a/data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml index 4ef2a0e0597e..3761f2e9322e 100644 --- a/data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml +++ b/data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml @@ -1,60 +1,64 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: ContributionOrder.field - description: "`field` will be removed. Only one order field is supported." - reason: "`field` will be removed." - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: Organization.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: RepositoryOwner.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: User.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: ContributionOrder.field + description: '`field` will be removed. Only one order field is supported.' + reason: '`field` will be removed.' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: Organization.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: RepositoryOwner.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: User.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling diff --git a/data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml index 972db51a7db4..7423aa02de6a 100644 --- a/data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml +++ b/data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml @@ -1,510 +1,538 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: ContributionOrder.field - description: "`field` will be removed. Only one order field is supported." - reason: "`field` will be removed." - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: Organization.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: RepositoryOwner.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: User.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: EnterpriseBillingInfo.availableSeats - description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses - instead." - reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide - more clarity on the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: EnterpriseBillingInfo.seats - description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead." - reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on - the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: Organization.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Organization.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.color - description: "`color` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.latestVersion - description: "`latestVersion` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.name - description: "`name` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.nameWithOwner - description: "`nameWithOwner` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageFileByGuid - description: "`packageFileByGuid` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageFileBySha256 - description: "`packageFileBySha256` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageType - description: "`packageType` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.preReleaseVersions - description: "`preReleaseVersions` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.registryPackageType - description: "`registryPackageType` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.repository - description: "`repository` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.statistics - description: "`statistics` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.tags - description: "`tags` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.topics - description: "`topics` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.version - description: "`version` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionByPlatform - description: "`versionByPlatform` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionBySha256 - description: "`versionBySha256` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versions - description: "`versions` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionsByMetadatum - description: "`versionsByMetadatum` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.dependencyType - description: "`dependencyType` will be removed. Use the `PackageDependency` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.name - description: "`name` will be removed. Use the `PackageDependency` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.version - description: "`version` will be removed. Use the `PackageDependency` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.guid - description: "`guid` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.md5 - description: "`md5` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.metadataUrl - description: "`metadataUrl` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.name - description: "`name` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.packageVersion - description: "`packageVersion` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.sha1 - description: "`sha1` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.sha256 - description: "`sha256` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.size - description: "`size` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.url - description: "`url` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageOwner.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageSearch.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisMonth - description: "`downloadsThisMonth` will be removed. Use the `PackageStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisWeek - description: "`downloadsThisWeek` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisYear - description: "`downloadsThisYear` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsToday - description: "`downloadsToday` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsTotalCount - description: "`downloadsTotalCount` will be removed. Use the `PackageStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageTag.name - description: "`name` will be removed. Use the `PackageTag` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageTag.version - description: "`version` will be removed. Use the `PackageTag` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.dependencies - description: "`dependencies` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.fileByName - description: "`fileByName` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.files - description: "`files` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.installationCommand - description: "`installationCommand` will be removed. Use the `PackageVersion` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.manifest - description: "`manifest` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.platform - description: "`platform` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.preRelease - description: "`preRelease` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.readme - description: "`readme` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.readmeHtml - description: "`readmeHtml` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.registryPackage - description: "`registryPackage` will be removed. Use the `PackageVersion` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.release - description: "`release` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.sha256 - description: "`sha256` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.size - description: "`size` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.statistics - description: "`statistics` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.summary - description: "`summary` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.updatedAt - description: "`updatedAt` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.version - description: "`version` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.viewerCanEdit - description: "`viewerCanEdit` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisMonth - description: "`downloadsThisMonth` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisWeek - description: "`downloadsThisWeek` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisYear - description: "`downloadsThisYear` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsToday - description: "`downloadsToday` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsTotalCount - description: "`downloadsTotalCount` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Repository.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Repository.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Sponsorship.maintainer - description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead." - reason: "`Sponsorship.maintainer` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: User.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: User.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: ContributionOrder.field + description: '`field` will be removed. Only one order field is supported.' + reason: '`field` will be removed.' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: Organization.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: RepositoryOwner.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: User.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: EnterpriseBillingInfo.availableSeats + description: + '`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses + instead.' + reason: + '`availableSeats` will be replaced with `totalAvailableLicenses` to provide + more clarity on the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: EnterpriseBillingInfo.seats + description: '`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead.' + reason: + '`seats` will be replaced with `totalLicenses` to provide more clarity on + the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: Organization.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Organization.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.color + description: '`color` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.latestVersion + description: '`latestVersion` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.name + description: '`name` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.nameWithOwner + description: '`nameWithOwner` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageFileByGuid + description: '`packageFileByGuid` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageFileBySha256 + description: '`packageFileBySha256` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageType + description: '`packageType` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.preReleaseVersions + description: '`preReleaseVersions` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.registryPackageType + description: '`registryPackageType` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.repository + description: '`repository` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.statistics + description: '`statistics` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.tags + description: '`tags` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.topics + description: '`topics` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.version + description: '`version` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionByPlatform + description: '`versionByPlatform` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionBySha256 + description: '`versionBySha256` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versions + description: '`versions` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionsByMetadatum + description: '`versionsByMetadatum` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.dependencyType + description: + '`dependencyType` will be removed. Use the `PackageDependency` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.name + description: '`name` will be removed. Use the `PackageDependency` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.version + description: '`version` will be removed. Use the `PackageDependency` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.guid + description: '`guid` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.md5 + description: '`md5` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.metadataUrl + description: '`metadataUrl` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.name + description: '`name` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.packageVersion + description: '`packageVersion` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.sha1 + description: '`sha1` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.sha256 + description: '`sha256` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.size + description: '`size` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.url + description: '`url` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageOwner.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageSearch.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisMonth + description: + '`downloadsThisMonth` will be removed. Use the `PackageStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisWeek + description: + '`downloadsThisWeek` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisYear + description: + '`downloadsThisYear` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsToday + description: + '`downloadsToday` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsTotalCount + description: + '`downloadsTotalCount` will be removed. Use the `PackageStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageTag.name + description: '`name` will be removed. Use the `PackageTag` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageTag.version + description: '`version` will be removed. Use the `PackageTag` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.dependencies + description: '`dependencies` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.fileByName + description: '`fileByName` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.files + description: '`files` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.installationCommand + description: + '`installationCommand` will be removed. Use the `PackageVersion` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.manifest + description: '`manifest` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.platform + description: '`platform` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.preRelease + description: '`preRelease` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.readme + description: '`readme` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.readmeHtml + description: '`readmeHtml` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.registryPackage + description: + '`registryPackage` will be removed. Use the `PackageVersion` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.release + description: '`release` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.sha256 + description: '`sha256` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.size + description: '`size` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.statistics + description: '`statistics` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.summary + description: '`summary` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.updatedAt + description: '`updatedAt` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.version + description: '`version` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.viewerCanEdit + description: '`viewerCanEdit` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisMonth + description: + '`downloadsThisMonth` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisWeek + description: + '`downloadsThisWeek` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisYear + description: + '`downloadsThisYear` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsToday + description: + '`downloadsToday` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsTotalCount + description: + '`downloadsTotalCount` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Repository.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Repository.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Sponsorship.maintainer + description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' + reason: '`Sponsorship.maintainer` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: User.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: User.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi diff --git a/data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml index e9d73de3205d..c230b126ac6b 100644 --- a/data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml +++ b/data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml @@ -1,516 +1,544 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: ContributionOrder.field - description: "`field` will be removed. Only one order field is supported." - reason: "`field` will be removed." - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Organization.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: RepositoryOwner.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: User.pinnedRepositories - description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems - instead." - reason: pinnedRepositories will be removed - date: '2019-10-01T00:00:00+00:00' - criticality: breaking - owner: cheshire137 -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: EnterpriseBillingInfo.availableSeats - description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses - instead." - reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide - more clarity on the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: EnterpriseBillingInfo.seats - description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead." - reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on - the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: Organization.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Organization.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.color - description: "`color` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.latestVersion - description: "`latestVersion` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.name - description: "`name` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.nameWithOwner - description: "`nameWithOwner` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageFileByGuid - description: "`packageFileByGuid` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageFileBySha256 - description: "`packageFileBySha256` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.packageType - description: "`packageType` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.preReleaseVersions - description: "`preReleaseVersions` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.registryPackageType - description: "`registryPackageType` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.repository - description: "`repository` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.statistics - description: "`statistics` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.tags - description: "`tags` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.topics - description: "`topics` will be removed. Use the `Package` object." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.version - description: "`version` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionByPlatform - description: "`versionByPlatform` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionBySha256 - description: "`versionBySha256` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versions - description: "`versions` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackage.versionsByMetadatum - description: "`versionsByMetadatum` will be removed. Use the `Package` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.dependencyType - description: "`dependencyType` will be removed. Use the `PackageDependency` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.name - description: "`name` will be removed. Use the `PackageDependency` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageDependency.version - description: "`version` will be removed. Use the `PackageDependency` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.guid - description: "`guid` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.md5 - description: "`md5` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.metadataUrl - description: "`metadataUrl` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.name - description: "`name` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.packageVersion - description: "`packageVersion` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.sha1 - description: "`sha1` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.sha256 - description: "`sha256` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.size - description: "`size` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageFile.url - description: "`url` will be removed. Use the `PackageFile` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageOwner.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageSearch.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisMonth - description: "`downloadsThisMonth` will be removed. Use the `PackageStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisWeek - description: "`downloadsThisWeek` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsThisYear - description: "`downloadsThisYear` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsToday - description: "`downloadsToday` will be removed. Use the `PackageStatistics` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageStatistics.downloadsTotalCount - description: "`downloadsTotalCount` will be removed. Use the `PackageStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageTag.name - description: "`name` will be removed. Use the `PackageTag` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageTag.version - description: "`version` will be removed. Use the `PackageTag` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.deleted - description: "`deleted` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.dependencies - description: "`dependencies` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.fileByName - description: "`fileByName` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.files - description: "`files` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.installationCommand - description: "`installationCommand` will be removed. Use the `PackageVersion` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.manifest - description: "`manifest` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.platform - description: "`platform` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.preRelease - description: "`preRelease` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.readme - description: "`readme` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.readmeHtml - description: "`readmeHtml` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.registryPackage - description: "`registryPackage` will be removed. Use the `PackageVersion` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.release - description: "`release` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.sha256 - description: "`sha256` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.size - description: "`size` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.statistics - description: "`statistics` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.summary - description: "`summary` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.updatedAt - description: "`updatedAt` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.version - description: "`version` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersion.viewerCanEdit - description: "`viewerCanEdit` will be removed. Use the `PackageVersion` object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisMonth - description: "`downloadsThisMonth` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisWeek - description: "`downloadsThisWeek` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsThisYear - description: "`downloadsThisYear` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsToday - description: "`downloadsToday` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: RegistryPackageVersionStatistics.downloadsTotalCount - description: "`downloadsTotalCount` will be removed. Use the `PackageVersionStatistics` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Repository.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Repository.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Sponsorship.maintainer - description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead." - reason: "`Sponsorship.maintainer` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: User.registryPackages - description: "`registryPackages` will be removed. Use the `PackageOwner` object - instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: User.registryPackagesForQuery - description: "`registryPackagesForQuery` will be removed. Use the `PackageSearch` - object instead." - reason: Renaming GitHub Packages fields and objects. - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: dinahshi -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: ContributionOrder.field + description: '`field` will be removed. Only one order field is supported.' + reason: '`field` will be removed.' + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Organization.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: RepositoryOwner.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: User.pinnedRepositories + description: + '`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems + instead.' + reason: pinnedRepositories will be removed + date: '2019-10-01T00:00:00+00:00' + criticality: breaking + owner: cheshire137 + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: EnterpriseBillingInfo.availableSeats + description: + '`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses + instead.' + reason: + '`availableSeats` will be replaced with `totalAvailableLicenses` to provide + more clarity on the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: EnterpriseBillingInfo.seats + description: '`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead.' + reason: + '`seats` will be replaced with `totalLicenses` to provide more clarity on + the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: Organization.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Organization.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.color + description: '`color` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.latestVersion + description: '`latestVersion` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.name + description: '`name` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.nameWithOwner + description: '`nameWithOwner` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageFileByGuid + description: '`packageFileByGuid` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageFileBySha256 + description: '`packageFileBySha256` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.packageType + description: '`packageType` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.preReleaseVersions + description: '`preReleaseVersions` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.registryPackageType + description: '`registryPackageType` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.repository + description: '`repository` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.statistics + description: '`statistics` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.tags + description: '`tags` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.topics + description: '`topics` will be removed. Use the `Package` object.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.version + description: '`version` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionByPlatform + description: '`versionByPlatform` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionBySha256 + description: '`versionBySha256` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versions + description: '`versions` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackage.versionsByMetadatum + description: '`versionsByMetadatum` will be removed. Use the `Package` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.dependencyType + description: + '`dependencyType` will be removed. Use the `PackageDependency` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.name + description: '`name` will be removed. Use the `PackageDependency` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageDependency.version + description: '`version` will be removed. Use the `PackageDependency` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.guid + description: '`guid` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.md5 + description: '`md5` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.metadataUrl + description: '`metadataUrl` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.name + description: '`name` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.packageVersion + description: '`packageVersion` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.sha1 + description: '`sha1` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.sha256 + description: '`sha256` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.size + description: '`size` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageFile.url + description: '`url` will be removed. Use the `PackageFile` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageOwner.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageSearch.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisMonth + description: + '`downloadsThisMonth` will be removed. Use the `PackageStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisWeek + description: + '`downloadsThisWeek` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsThisYear + description: + '`downloadsThisYear` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsToday + description: + '`downloadsToday` will be removed. Use the `PackageStatistics` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageStatistics.downloadsTotalCount + description: + '`downloadsTotalCount` will be removed. Use the `PackageStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageTag.name + description: '`name` will be removed. Use the `PackageTag` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageTag.version + description: '`version` will be removed. Use the `PackageTag` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.deleted + description: '`deleted` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.dependencies + description: '`dependencies` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.fileByName + description: '`fileByName` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.files + description: '`files` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.installationCommand + description: + '`installationCommand` will be removed. Use the `PackageVersion` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.manifest + description: '`manifest` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.platform + description: '`platform` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.preRelease + description: '`preRelease` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.readme + description: '`readme` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.readmeHtml + description: '`readmeHtml` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.registryPackage + description: + '`registryPackage` will be removed. Use the `PackageVersion` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.release + description: '`release` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.sha256 + description: '`sha256` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.size + description: '`size` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.statistics + description: '`statistics` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.summary + description: '`summary` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.updatedAt + description: '`updatedAt` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.version + description: '`version` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersion.viewerCanEdit + description: '`viewerCanEdit` will be removed. Use the `PackageVersion` object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisMonth + description: + '`downloadsThisMonth` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisWeek + description: + '`downloadsThisWeek` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsThisYear + description: + '`downloadsThisYear` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsToday + description: + '`downloadsToday` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: RegistryPackageVersionStatistics.downloadsTotalCount + description: + '`downloadsTotalCount` will be removed. Use the `PackageVersionStatistics` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Repository.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Repository.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Sponsorship.maintainer + description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' + reason: '`Sponsorship.maintainer` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: User.registryPackages + description: + '`registryPackages` will be removed. Use the `PackageOwner` object + instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: User.registryPackagesForQuery + description: + '`registryPackagesForQuery` will be removed. Use the `PackageSearch` + object instead.' + reason: Renaming GitHub Packages fields and objects. + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: dinahshi + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea diff --git a/data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml index b373b23923bf..a68804e2ed7b 100644 --- a/data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml +++ b/data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml @@ -1,117 +1,124 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: EnterpriseBillingInfo.availableSeats - description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses - instead." - reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide - more clarity on the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: EnterpriseBillingInfo.seats - description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead." - reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on - the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: Sponsorship.maintainer - description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead." - reason: "`Sponsorship.maintainer` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: EnterprisePendingMemberInvitationEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending members consume a license - date: '2020-07-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOwnerInfo.pendingCollaborators - description: "`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` - field instead." - reason: Repository invitations can now be associated with an email, not only an - invitee. - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: RepositoryCollaboratorEdge.permission - description: Type for `permission` will change from `RepositoryPermission!` to `String`. - reason: This field may return additional values - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: oneill38 -- location: RepositoryInvitation.permission - description: Type for `permission` will change from `RepositoryPermission!` to `String`. - reason: This field may return additional values - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: oneill38 -- location: RepositoryInvitationOrderField.INVITEE_LOGIN - description: "`INVITEE_LOGIN` will be removed." - reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations - can now be associated with an email, not only an invitee." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Sponsorship.sponsor - description: "`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead." - reason: "`Sponsorship.sponsor` will be removed." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: nholden -- location: TeamRepositoryEdge.permission - description: Type for `permission` will change from `RepositoryPermission!` to `String`. - reason: This field may return additional values - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: oneill38 -- location: EnterpriseMemberEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All members consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOutsideCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All outside collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterprisePendingCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: EnterpriseBillingInfo.availableSeats + description: + '`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses + instead.' + reason: + '`availableSeats` will be replaced with `totalAvailableLicenses` to provide + more clarity on the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: EnterpriseBillingInfo.seats + description: '`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead.' + reason: + '`seats` will be replaced with `totalLicenses` to provide more clarity on + the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: Sponsorship.maintainer + description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' + reason: '`Sponsorship.maintainer` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: EnterprisePendingMemberInvitationEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending members consume a license + date: '2020-07-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOwnerInfo.pendingCollaborators + description: + '`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` + field instead.' + reason: + Repository invitations can now be associated with an email, not only an + invitee. + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: RepositoryCollaboratorEdge.permission + description: Type for `permission` will change from `RepositoryPermission!` to `String`. + reason: This field may return additional values + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: oneill38 + - location: RepositoryInvitation.permission + description: Type for `permission` will change from `RepositoryPermission!` to `String`. + reason: This field may return additional values + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: oneill38 + - location: RepositoryInvitationOrderField.INVITEE_LOGIN + description: '`INVITEE_LOGIN` will be removed.' + reason: + '`INVITEE_LOGIN` is no longer a valid field value. Repository invitations + can now be associated with an email, not only an invitee.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Sponsorship.sponsor + description: '`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead.' + reason: '`Sponsorship.sponsor` will be removed.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: nholden + - location: TeamRepositoryEdge.permission + description: Type for `permission` will change from `RepositoryPermission!` to `String`. + reason: This field may return additional values + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: oneill38 + - location: EnterpriseMemberEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All members consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOutsideCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All outside collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterprisePendingCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon diff --git a/data/graphql/graphql_previews.yml b/data/graphql/graphql_previews.yml index 6b8e09178014..2250a53638ad 100644 --- a/data/graphql/graphql_previews.yml +++ b/data/graphql/graphql_previews.yml @@ -99,7 +99,7 @@ toggled_on: - Mutation.createContentAttachment owning_teams: - - '@github/ce-extensibility' + - '@github/feature-lifecycle' - title: Pinned Issues Preview description: This preview adds support for pinned issues. toggled_by: ':elektra-preview' diff --git a/data/graphql/graphql_upcoming_changes.public.yml b/data/graphql/graphql_upcoming_changes.public.yml index 3af44bb5429f..27c932e7334a 100644 --- a/data/graphql/graphql_upcoming_changes.public.yml +++ b/data/graphql/graphql_upcoming_changes.public.yml @@ -1,113 +1,122 @@ --- upcoming_changes: -- location: Migration.uploadUrlTemplate - description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead." - reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and - adds an extra user step." - date: '2019-04-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: AssignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: EnterpriseBillingInfo.availableSeats - description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses - instead." - reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide - more clarity on the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: EnterpriseBillingInfo.seats - description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead." - reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on - the value being returned" - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: BlakeWilliams -- location: UnassignedEvent.user - description: "`user` will be removed. Use the `assignee` field instead." - reason: Assignees can now be mannequins. - date: '2020-01-01T00:00:00+00:00' - criticality: breaking - owner: tambling -- location: Query.sponsorsListing - description: "`sponsorsListing` will be removed. Use `Sponsorable.sponsorsListing` - instead." - reason: "`Query.sponsorsListing` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: Sponsorship.maintainer - description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead." - reason: "`Sponsorship.maintainer` will be removed." - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn -- location: EnterprisePendingMemberInvitationEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending members consume a license - date: '2020-07-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOwnerInfo.pendingCollaborators - description: "`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` - field instead." - reason: Repository invitations can now be associated with an email, not only an - invitee. - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Issue.timeline - description: "`timeline` will be removed. Use Issue.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: PullRequest.timeline - description: "`timeline` will be removed. Use PullRequest.timelineItems instead." - reason: "`timeline` will be removed" - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: mikesea -- location: RepositoryInvitationOrderField.INVITEE_LOGIN - description: "`INVITEE_LOGIN` will be removed." - reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations - can now be associated with an email, not only an invitee." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: jdennes -- location: Sponsorship.sponsor - description: "`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead." - reason: "`Sponsorship.sponsor` will be removed." - date: '2020-10-01T00:00:00+00:00' - criticality: breaking - owner: nholden -- location: EnterpriseMemberEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All members consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterpriseOutsideCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All outside collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: EnterprisePendingCollaboratorEdge.isUnlicensed - description: "`isUnlicensed` will be removed." - reason: All pending collaborators consume a license - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: BrentWheeldon -- location: MergeStateStatus.DRAFT - description: "`DRAFT` will be removed. Use PullRequest.isDraft instead." - reason: DRAFT state will be removed from this enum and `isDraft` should be used - instead - date: '2021-01-01T00:00:00+00:00' - criticality: breaking - owner: nplasterer + - location: Migration.uploadUrlTemplate + description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.' + reason: + '`uploadUrlTemplate` is being removed because it is not a standard URL and + adds an extra user step.' + date: '2019-04-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: AssignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: EnterpriseBillingInfo.availableSeats + description: + '`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses + instead.' + reason: + '`availableSeats` will be replaced with `totalAvailableLicenses` to provide + more clarity on the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: EnterpriseBillingInfo.seats + description: '`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead.' + reason: + '`seats` will be replaced with `totalLicenses` to provide more clarity on + the value being returned' + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: BlakeWilliams + - location: UnassignedEvent.user + description: '`user` will be removed. Use the `assignee` field instead.' + reason: Assignees can now be mannequins. + date: '2020-01-01T00:00:00+00:00' + criticality: breaking + owner: tambling + - location: Query.sponsorsListing + description: + '`sponsorsListing` will be removed. Use `Sponsorable.sponsorsListing` + instead.' + reason: '`Query.sponsorsListing` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: Sponsorship.maintainer + description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' + reason: '`Sponsorship.maintainer` will be removed.' + date: '2020-04-01T00:00:00+00:00' + criticality: breaking + owner: antn + - location: EnterprisePendingMemberInvitationEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending members consume a license + date: '2020-07-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOwnerInfo.pendingCollaborators + description: + '`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations` + field instead.' + reason: + Repository invitations can now be associated with an email, not only an + invitee. + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Issue.timeline + description: '`timeline` will be removed. Use Issue.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: PullRequest.timeline + description: '`timeline` will be removed. Use PullRequest.timelineItems instead.' + reason: '`timeline` will be removed' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: mikesea + - location: RepositoryInvitationOrderField.INVITEE_LOGIN + description: '`INVITEE_LOGIN` will be removed.' + reason: + '`INVITEE_LOGIN` is no longer a valid field value. Repository invitations + can now be associated with an email, not only an invitee.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: jdennes + - location: Sponsorship.sponsor + description: '`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead.' + reason: '`Sponsorship.sponsor` will be removed.' + date: '2020-10-01T00:00:00+00:00' + criticality: breaking + owner: nholden + - location: EnterpriseMemberEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All members consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterpriseOutsideCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All outside collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: EnterprisePendingCollaboratorEdge.isUnlicensed + description: '`isUnlicensed` will be removed.' + reason: All pending collaborators consume a license + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: BrentWheeldon + - location: MergeStateStatus.DRAFT + description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.' + reason: + DRAFT state will be removed from this enum and `isDraft` should be used + instead + date: '2021-01-01T00:00:00+00:00' + criticality: breaking + owner: nplasterer diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 208d3b7aed58..5a45a09a79a4 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -1812,6 +1812,11 @@ enum CheckConclusionState { """ STALE + """ + The check suite or run has failed at startup. + """ + STARTUP_FAILURE + """ The check suite or run has succeeded. """ @@ -6935,6 +6940,11 @@ enum DeploymentState { The deployment has queued """ QUEUED + + """ + The deployment is waiting. + """ + WAITING } """ @@ -11432,6 +11442,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ @@ -12023,6 +12038,31 @@ type IssueCommentEdge { node: IssueComment } +""" +Ways in which lists of issue comments can be ordered upon return. +""" +input IssueCommentOrder { + """ + The direction in which to order issue comments by the specified field. + """ + direction: OrderDirection! + + """ + The field in which to order issue comments by. + """ + field: IssueCommentOrderField! +} + +""" +Properties by which issue comment connections can be ordered. +""" +enum IssueCommentOrderField { + """ + Order issue comments by update time + """ + UPDATED_AT +} + """ The connection type for Issue. """ @@ -13030,12 +13070,12 @@ input LockLockableInput { clientMutationId: String """ - A reason for why the issue or pull request will be locked. + A reason for why the item will be locked. """ lockReason: LockReason """ - ID of the issue or pull request to be locked. + ID of the item to be locked. """ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") } @@ -18661,6 +18701,11 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr The organization's public email. """ email: String + + """ + True if this user/organization has a GitHub Sponsors listing. + """ + hasSponsorsListing: Boolean! id: ID! """ @@ -18698,6 +18743,11 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} ): IpAllowListEntryConnection! + """ + True if the viewer is sponsored by this user/organization. + """ + isSponsoringViewer: Boolean! + """ Whether the organization has verified its profile email and website, always false on Enterprise. """ @@ -19075,7 +19125,7 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr samlIdentityProvider: OrganizationIdentityProvider """ - The GitHub Sponsors listing for this user. + The GitHub Sponsors listing for this user or organization. """ sponsorsListing: SponsorsListing @@ -19266,11 +19316,21 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ viewerCanCreateTeams: Boolean! + """ + Whether or not the viewer is able to sponsor this user/organization. + """ + viewerCanSponsor: Boolean! + """ Viewer is an active member of this organization. """ viewerIsAMember: Boolean! + """ + True if the viewer is sponsoring this user/organization. + """ + viewerIsSponsoring: Boolean! + """ The organization's public profile URL. """ @@ -21876,6 +21936,11 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ @@ -31946,7 +32011,17 @@ Entities that can be sponsored through GitHub Sponsors """ interface Sponsorable { """ - The GitHub Sponsors listing for this user. + True if this user/organization has a GitHub Sponsors listing. + """ + hasSponsorsListing: Boolean! + + """ + True if the viewer is sponsored by this user/organization. + """ + isSponsoringViewer: Boolean! + + """ + The GitHub Sponsors listing for this user or organization. """ sponsorsListing: SponsorsListing @@ -32016,6 +32091,16 @@ interface Sponsorable { """ orderBy: SponsorshipOrder ): SponsorshipConnection! + + """ + Whether or not the viewer is able to sponsor this user/organization. + """ + viewerCanSponsor: Boolean! + + """ + True if the viewer is sponsoring this user/organization. + """ + viewerIsSponsoring: Boolean! } """ @@ -32272,7 +32357,7 @@ type Sponsorship implements Node { sponsor: User @deprecated(reason: "`Sponsorship.sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead. Removal on 2020-10-01 UTC.") """ - The user or organization that is sponsoring. Returns null if the sponsorship is private. + The user or organization that is sponsoring, if you have permission to view them. """ sponsorEntity: Sponsor @@ -35511,7 +35596,7 @@ input UnlockLockableInput { clientMutationId: String """ - ID of the issue or pull request to be unlocked. + ID of the item to be unlocked. """ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") } @@ -37799,6 +37884,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & privacy: GistPrivacy ): GistConnection! + """ + True if this user/organization has a GitHub Sponsors listing. + """ + hasSponsorsListing: Boolean! + """ The hovercard information for this user in a given context """ @@ -37840,6 +37930,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ isSiteAdmin: Boolean! + """ + True if the viewer is sponsored by this user/organization. + """ + isSponsoringViewer: Boolean! + """ Whether or not this user is the viewing user. """ @@ -37868,6 +37963,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & Returns the last _n_ elements from the list. """ last: Int + + """ + Ordering options for issue comments returned from the connection. + """ + orderBy: IssueCommentOrder ): IssueCommentConnection! """ @@ -38382,7 +38482,7 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & ): SavedReplyConnection """ - The GitHub Sponsors listing for this user. + The GitHub Sponsors listing for this user or organization. """ sponsorsListing: SponsorsListing @@ -38558,11 +38658,21 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ viewerCanFollow: Boolean! + """ + Whether or not the viewer is able to sponsor this user/organization. + """ + viewerCanSponsor: Boolean! + """ Whether or not this user is followed by the viewer. """ viewerIsFollowing: Boolean! + """ + True if the viewer is sponsoring this user/organization. + """ + viewerIsSponsoring: Boolean! + """ A list of repositories the given user is watching. """ diff --git a/data/products.yml b/data/products.yml index 96e85ce3733e..1ec0286139de 100644 --- a/data/products.yml +++ b/data/products.yml @@ -10,4 +10,4 @@ productsInOrder: - rest - graphql - insights - - desktop \ No newline at end of file + - desktop diff --git a/data/ui.yml b/data/ui.yml index bbd8b3b1c3a1..d144567335c1 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -2,8 +2,7 @@ header: github_docs: GitHub Docs contact: Contact notices: - ghae_silent_launch: - GitHub AE is currently under limited release. Please contact our Sales Team to find out more. + ghae_silent_launch: GitHub AE is currently under limited release. Please contact our Sales Team to find out more. release_candidate: # The version name is rendered before the below text via includes/header-notification.html ' is currently under limited release as a release candidate.' @@ -18,8 +17,7 @@ header: still in translation. For the most up-to-date and accurate information, please visit our English documentation. - early_access: - 👋 This page contains content about an early access feature. Please do not share this URL publicly. + early_access: 👋 This page contains content about an early access feature. Please do not share this URL publicly. search: need_help: Need help? placeholder: Search topics, products... @@ -32,7 +30,7 @@ toc: guides: Guides whats_new: What's new pages: - article_version: "Article version:" + article_version: 'Article version:' miniToc: In this article errors: oops: Ooops! diff --git a/data/variables/action_code_examples.yml b/data/variables/action_code_examples.yml index a0f12b03840c..bb6a3e374219 100644 --- a/data/variables/action_code_examples.yml +++ b/data/variables/action_code_examples.yml @@ -18,7 +18,7 @@ tags: - issues - labels -- title: Declaratively sync GitHub lables +- title: Declaratively sync GitHub labels description: GitHub Action to sync GitHub labels in the declarative way languages: 'Go, Dockerfile' href: micnncim/action-label-syncer diff --git a/data/variables/contact.yml b/data/variables/contact.yml index b9cbf4c5d6d6..2b576108a8d3 100644 --- a/data/variables/contact.yml +++ b/data/variables/contact.yml @@ -15,7 +15,7 @@ contact_dmca: >- contact_privacy: >- {% if currentVersion == "free-pro-team@latest" %}[Privacy contact form](https://github.com/contact/privacy){% endif %} -contact_enterprise_sales: '[GitHub''s Sales team](https://enterprise.github.com/contact)' +contact_enterprise_sales: "[GitHub's Sales team](https://enterprise.github.com/contact)" contact_feedback_actions: '[Feedback form for GitHub Actions](https://support.github.com/contact/feedback?contact[category]=actions)' diff --git a/data/variables/product.yml b/data/variables/product.yml index 1f867437ef65..197ca516570b 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -27,7 +27,7 @@ prodname_ghe_one: 'GitHub One' ## Use these variables when referring specifically to a location within a product product_location: >- {% if enterpriseServerVersions contains currentVersion %}your GitHub Enterprise Server instance{% elsif currentVersion == "github-ae@latest" %}your enterprise{% else %}GitHub{% endif %} - + # Used ONLY when you need to refer to a GHES instance in an article that is versioned for non-GHES versions. # Do not use in other situations! product_location_enterprise: 'your GitHub Enterprise Server instance' @@ -170,8 +170,7 @@ signout_link: >- raw_github_com: >- {% if currentVersion == "free-pro-team@latest" %}raw.githubusercontent.com{% else %}[hostname]/user/repo/raw{% endif %} # GitHub Enterprise Server past versions -current-340-version: - '11.10.354' +current-340-version: '11.10.354' # Developer site product variables # Use this inside command-line and other code blocks @@ -194,4 +193,4 @@ graphql_url_pre: >- {% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %} # Use this all other code blocks graphql_url_code: >- - {% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %} \ No newline at end of file + {% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %} diff --git a/includes/article.html b/includes/article.html index e448c18d8f71..30d3f67b8f02 100644 --- a/includes/article.html +++ b/includes/article.html @@ -69,10 +69,11 @@

+ {% assign helpId = 'sm' %} + {% include helpfulness %} + {% include contribution %} + -
- {% assign helpId = 'sm' %} - {% include helpfulness %} - {% include contribution %} -
diff --git a/includes/sidebar-specific-product.html b/includes/sidebar-specific-product.html index 36ff7df74f30..d9d625070437 100644 --- a/includes/sidebar-specific-product.html +++ b/includes/sidebar-specific-product.html @@ -23,11 +23,14 @@
{{ category[1].title }} + {% if breadcrumbs.category.href == category[1].href or forloop.index < 4 %} + {% endif %}
{% endif %} + {% if breadcrumbs.category.href == category[1].href or forloop.index < 4 %} {% if category[1].maptopics %}
    {% for maptopic in category[1].maptopics %} @@ -60,6 +63,7 @@ {% endfor %}
{% endif %} + {% endif %} {% endfor %} diff --git a/includes/small-footer.html b/includes/small-footer.html index e12574749bbb..3c71ddc601dc 100644 --- a/includes/small-footer.html +++ b/includes/small-footer.html @@ -1,11 +1,10 @@