[cli/docs]Add GitHub Loader TypeScript type, update usage docs #9332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 003e725 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
diff --git a/website/algolia-lockfile.json b/website/algolia-lockfile.json
index ed978e0b9..aa1a240da 100644
--- a/website/algolia-lockfile.json
+++ b/website/algolia-lockfile.json
@@ -533,7 +533,7 @@
"anchor": "custom-schema-loader"
}
],
- "content": "2741d5131dc2271008489e0448732efe",
+ "content": "e915dbb1de2cd152d6847b91fdb643c0",
"url": "https://www.the-guild.dev/graphql/codegen/docs/config-reference/schema-field",
"domain": "https://www.the-guild.dev/graphql/codegen",
"hierarchy": [ |
💻 Website PreviewThe latest changes are available as preview in: https://3ad03f6b.graphql-code-generator.pages.dev |
eddeee888
force-pushed
the
update-github-loader-docs
branch
from
646309f
to
3b1b47a
Compare
ardatan
reviewed
Apr 23, 2023
| @@ -183,6 +183,10 @@ export namespace Types { | |||
| 'apollo-engine': ApolloEngineOptions; | |||
| } | |||
|
|
|||
| export interface GitHubSchemaOptions { | |||
| [githubProtocol: string]: { token: string }; | |||
There was a problem hiding this comment.
github:${string} Do you think this works better?
There was a problem hiding this comment.
I like that 👍 However, looks like the website GH actions can only generate json schema for number or string index.
Example failed build: https://github.com/dotansimha/graphql-code-generator/actions/runs/4784244922/jobs/8505729237?pr=9332
eddeee888
force-pushed
the
update-github-loader-docs
branch
from
699b68f
to
003e725
Compare
saihaj
approved these changes
May 15, 2023
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves schema Github Loader doc and TypeScript usability:
Related: #9281
Type of change
Screenshots/Sandbox (if appropriate/relevant):
Preview of updated doc
Using token no longer triggers TS errors
How Has This Been Tested?
Test Environment:
Checklist: