diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 77f2881dc..1bb9ac3c2 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,12 +13,12 @@ name: "CodeQL" on: push: - branches: [ "main" ] + branches: ["main"] pull_request: # The branches below must be a subset of the branches above - branches: [ "main" ] + branches: ["main"] schedule: - - cron: '19 9 * * 0' + - cron: "19 9 * * 0" jobs: analyze: @@ -32,41 +32,40 @@ jobs: strategy: fail-fast: false matrix: - language: [ 'javascript' ] + language: ["javascript"] # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support steps: - - name: Checkout repository - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 + - name: Checkout repository + uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - - # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 - # If the Autobuild fails above, remove it and uncomment the following three lines. - # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - # - run: | - # echo "Run, Build Application using script" - # ./location_of_script_within_repo/buildscript.sh + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2 diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml new file mode 100644 index 000000000..d1e5af32a --- /dev/null +++ b/.github/workflows/prettier.yml @@ -0,0 +1,21 @@ +name: Prettier +"on": + push: + branches: + - main + pull_request: + types: + - opened + - synchronize +jobs: + prettier: + name: Do the files need to be linted? + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 + - uses: actions/setup-node@5b949b50c3461bbcd5a540b150c368278160234a # tag=v3 + with: + node-version: 16 + cache: npm + - run: npm ci + - run: npm run lint diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index feeaa9d29..408ed17bd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 - - uses: actions/setup-node@5b949b50c3461bbcd5a540b150c368278160234a # tag=v3 + - uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3 with: cache: npm node-version: 16 diff --git a/.github/workflows/update-prettier.yml b/.github/workflows/update-prettier.yml new file mode 100644 index 000000000..d169637b3 --- /dev/null +++ b/.github/workflows/update-prettier.yml @@ -0,0 +1,24 @@ +name: Update Prettier +"on": + push: + branches: + - renovate/prettier-* +jobs: + update_prettier: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 + - uses: actions/setup-node@5b949b50c3461bbcd5a540b150c368278160234a # tag=v3 + with: + node-version: 16 + cache: npm + - run: npm ci + - run: npm run lint:fix + - uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.OCTOKITBOT_PAT }} + with: + title: Prettier updated + body: An update to prettier required updates to your code. + branch: ${{ github.ref }} + commit-message: "style: prettier" diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml index 0d94b1817..20c213f44 100644 --- a/.github/workflows/update.yml +++ b/.github/workflows/update.yml @@ -19,7 +19,7 @@ jobs: github.event.client_payload.action == 'published' steps: - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 - - uses: actions/setup-node@5b949b50c3461bbcd5a540b150c368278160234a # tag=v3 + - uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3 with: cache: npm node-version: 16 diff --git a/SECURITY.md b/SECURITY.md index 0605b07db..4b7f6d06b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,8 +4,7 @@ Thanks for helping make GitHub Open Source Software safe for everyone. GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [Octokit](https://github.com/octokit). -Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we want to make sure that your finding gets passed along to the maintainers of this project for remediation. - +Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we want to make sure that your finding gets passed along to the maintainers of this project for remediation. ## Reporting a Vulnerability diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 9a291fbc5..50efffbd6 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -31819,7 +31819,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json index 3306bd022..ff45f64fc 100644 --- a/cache/ghes-3.2.json +++ b/cache/ghes-3.2.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -28492,7 +28492,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json index e1040fb69..845920da4 100644 --- a/cache/ghes-3.3.json +++ b/cache/ghes-3.3.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -28059,7 +28059,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json index dc76b0e44..7341c307b 100644 --- a/cache/ghes-3.4.json +++ b/cache/ghes-3.4.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -29478,7 +29478,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json index f989d0485..3eeb6bfb2 100644 --- a/cache/ghes-3.5.json +++ b/cache/ghes-3.5.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -30315,7 +30315,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/cache/github.ae.json b/cache/github.ae.json index 7f0f89f93..8746293ed 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "6.6.2", + "version": "6.6.3", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -25970,7 +25970,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "List requested reviewers for a pull request", - "description": "", + "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": ["pulls"], "operationId": "pulls/list-requested-reviewers", "externalDocs": { diff --git a/package-lock.json b/package-lock.json index 43cf96051..c825a8e3d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,7 +12,7 @@ "@octokit/core": "^4.0.0", "github-enterprise-server-versions": "^1.0.0", "openapi-typescript": "^5.0.0", - "prettier": "^2.3.2" + "prettier": "2.7.1" } }, "node_modules/@octokit/auth-token": { diff --git a/package.json b/package.json index 0089d2632..19c7b3097 100644 --- a/package.json +++ b/package.json @@ -12,13 +12,15 @@ "scripts": { "download": "node scripts/download", "generate-types": "node scripts/generate-types", - "update-package": "node scripts/update-package" + "update-package": "node scripts/update-package", + "lint": "prettier --check '*.{md,json}' 'scripts/*.js' 'packages/**/*.{ts,md,json,d.ts}'", + "lint:fix": "prettier --write '*.{md,json}' 'scripts/*.js' 'packages/**/*.{ts,md,json,d.ts}'" }, "devDependencies": { "@octokit/core": "^4.0.0", "github-enterprise-server-versions": "^1.0.0", "openapi-typescript": "^5.0.0", - "prettier": "^2.3.2" + "prettier": "2.7.1" }, "release": { "branches": [ diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json index ca9e67e96..1ee74acb6 100644 --- a/packages/openapi-types-ghes-3.2/package.json +++ b/packages/openapi-types-ghes-3.2/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types-ghes-3.2" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts index 1f4870563..987c3fdcf 100644 --- a/packages/openapi-types-ghes-3.2/types.d.ts +++ b/packages/openapi-types-ghes-3.2/types.d.ts @@ -3475,6 +3475,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -31834,6 +31835,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json index 167e51c03..1f5a00c2f 100644 --- a/packages/openapi-types-ghes-3.3/package.json +++ b/packages/openapi-types-ghes-3.3/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types-ghes-3.3" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts index 08c7fb29f..0b8bfbb1c 100644 --- a/packages/openapi-types-ghes-3.3/types.d.ts +++ b/packages/openapi-types-ghes-3.3/types.d.ts @@ -3529,6 +3529,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -32755,6 +32756,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json index d95f5d443..bb4926fe1 100644 --- a/packages/openapi-types-ghes-3.4/package.json +++ b/packages/openapi-types-ghes-3.4/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types-ghes-3.4" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts index 8c56d5418..9316c1bed 100644 --- a/packages/openapi-types-ghes-3.4/types.d.ts +++ b/packages/openapi-types-ghes-3.4/types.d.ts @@ -3863,6 +3863,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -34222,6 +34223,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json index e79f685fd..fedf40576 100644 --- a/packages/openapi-types-ghes-3.5/package.json +++ b/packages/openapi-types-ghes-3.5/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types-ghes-3.5" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts index edbfb00d2..7887e6273 100644 --- a/packages/openapi-types-ghes-3.5/types.d.ts +++ b/packages/openapi-types-ghes-3.5/types.d.ts @@ -4001,6 +4001,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -35628,6 +35629,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 302fb1cb0..998fe3dac 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types-github.ae" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 992f20afb..479e22c49 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -3306,6 +3306,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -31446,6 +31447,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 54a11b8af..26f6cc0e7 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -6,11 +6,15 @@ "url": "https://github.com/octokit/openapi-types.ts.git", "directory": "packages/openapi-types" }, - "publishConfig": { "access": "public" }, + "publishConfig": { + "access": "public" + }, "version": "0.0.0-development", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "6.6.2" } + "octokit": { + "openapi-version": "6.6.3" + } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 3dd4b4a36..776a08cda 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -4593,6 +4593,7 @@ export interface paths { put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["pulls/request-reviewers"]; @@ -39405,6 +39406,7 @@ export interface operations { }; }; }; + /** Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { path: { diff --git a/scripts/download.js b/scripts/download.js index 113c20179..c950c59f8 100644 --- a/scripts/download.js +++ b/scripts/download.js @@ -1,9 +1,9 @@ -import { get } from "node:https" -import { createWriteStream } from "node:fs" -import { mkdir, rm } from "node:fs/promises" +import { get } from "node:https"; +import { createWriteStream } from "node:fs"; +import { mkdir, rm } from "node:fs/promises"; -import { Octokit } from "@octokit/core" -import gheVersions from "github-enterprise-server-versions" +import { Octokit } from "@octokit/core"; +import gheVersions from "github-enterprise-server-versions"; const { getCurrentVersions } = gheVersions; if (!process.env.OCTOKIT_OPENAPI_VERSION) { diff --git a/scripts/generate-types.js b/scripts/generate-types.js index 89d9a8064..85715e70d 100644 --- a/scripts/generate-types.js +++ b/scripts/generate-types.js @@ -1,8 +1,8 @@ -import { readdir, mkdir, rm, writeFile, copyFile } from "node:fs/promises" -import { basename } from "node:path" +import { readdir, mkdir, rm, writeFile, copyFile } from "node:fs/promises"; +import { basename } from "node:path"; -import prettier from "prettier" -import openapiTS from "openapi-typescript" +import prettier from "prettier"; +import openapiTS from "openapi-typescript"; if (!process.env.OCTOKIT_OPENAPI_VERSION) { throw new Error("OCTOKIT_OPENAPI_VERSION is not set"); @@ -81,7 +81,7 @@ type Repository = components["schemas"]["full-repository"] { parser: "markdown" } ) ); - + await copyFile("LICENSE", `packages/${packageName}/LICENSE`); await writeFile( diff --git a/scripts/update-package.js b/scripts/update-package.js index ef315a5fa..f0fbaffca 100644 --- a/scripts/update-package.js +++ b/scripts/update-package.js @@ -1,4 +1,5 @@ -import { writeFile, readdir, readFile } from "node:fs/promises" +import { writeFile, readdir, readFile } from "node:fs/promises"; +import prettier from "prettier"; if (!process.env.OCTOKIT_OPENAPI_VERSION) { throw new Error("OCTOKIT_OPENAPI_VERSION is not set"); @@ -28,5 +29,8 @@ async function updatePackage() { }) ); - await writeFile("package.json", JSON.stringify(pkg, null, 2) + "\n"); + await writeFile( + "package.json", + prettier.format(JSON.stringify(pkg, null), { parser: "json" }) + ); }