From 84724927e3e992f17768c17f57a47a85ea2a5160 Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Wed, 8 Nov 2023 10:03:49 -0500 Subject: [PATCH] Only validate GraphQL `previews` --- .github/workflows/integration.yml | 8 ++++---- README.md | 2 ++ action.yml | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index 433dfb5d..80d176b0 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -66,7 +66,7 @@ jobs: echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY test-previews: - name: 'Integration test: previews option' + name: 'Integration test: GraphQL previews option' runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -77,7 +77,7 @@ jobs: with: script: | const endpoint = github.request.endpoint - return endpoint({}).headers.accept + return endpoint({url: \"/graphql\"}).headers.accept result-encoding: string - id: previews-set-single name: Previews set to a single value @@ -86,7 +86,7 @@ jobs: previews: foo script: | const endpoint = github.request.endpoint - return endpoint({}).headers.accept + return endpoint({url: \"/graphql\"}).headers.accept result-encoding: string - id: previews-set-multiple name: Previews set to comma-separated list @@ -95,7 +95,7 @@ jobs: previews: foo,bar,baz script: | const endpoint = github.request.endpoint - return endpoint({}).headers.accept + return endpoint({url: \"/graphql\"}).headers.accept result-encoding: string - run: | echo "- Validating previews default" diff --git a/README.md b/README.md index 62b19c37..09d8341f 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ Version 7 of this action updated the runtime to Node 20 - https://docs.github.co All scripts are now run with Node 20 instead of Node 16 and are affected by any breaking changes between Node 16 and 20 +The `previews` input now only applies to GraphQL API calls as REST API previews are no longer necessary - https://github.blog/changelog/2021-10-14-rest-api-preview-promotions/. + ### V6 Version 6 of this action updated the runtime to Node 16 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions diff --git a/action.yml b/action.yml index c877b035..12a726af 100644 --- a/action.yml +++ b/action.yml @@ -19,7 +19,7 @@ inputs: description: An optional user-agent string default: actions/github-script previews: - description: A comma-separated list of API previews to accept + description: A comma-separated list of GraphQL API previews to accept result-encoding: description: Either "string" or "json" (default "json")—how the result will be encoded default: json