docs(provider): auto-generate providers list #1295
Merged
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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextauthjs/next-auth/8igh187mi |
d41b6c8 to
9916bbd
Compare
|
🎉 This PR is included in version 3.3.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
mnphpexpert
added a commit
to mnphpexpert/next-auth
that referenced
this pull request
Sep 2, 2024
* docs: ignore providers.json * chore: generate providers.json from front-matter * chore: remove autogenerated file * docs(provider): rename vk.com to VK * docs: encourage adding new providers
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.
What:
Autogenerate a list of built-in providers from the providers' documentation frontmatter.
Why:
To reduce the effort needed to add a built-in provider even further.
From now on, you only need to add two files in these folders:
Docs: https://github.com/nextauthjs/next-auth/tree/main/www/docs/providers
Provider code: https://github.com/nextauthjs/next-auth/tree/main/src/providers
How:
Iterate over the
www/docs/providersfolder, and use a regex that writes provider ids and titles towww/providers.jsonChecklist:
closes #1157