-
-
Notifications
You must be signed in to change notification settings - Fork 6
Beta.23 #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Beta.23 #151
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ba9150f
feat(auth): streamline authentication providers to only support usern…
Adammatthiesen 7a9a6a2
feat(docs): add upgrade guide for 0.1.0-beta.23 with breaking changes…
Adammatthiesen db94b9e
refactor(docs): remove optional OAuth environment variables section f…
Adammatthiesen 1bcf895
fix(docs): adjust code block range for `usernameAndPassword` usage ex…
Adammatthiesen 6b3a1ef
fix(docs): update code block syntax for environment variables to use …
Adammatthiesen 67a9c20
fix(docs): remove 'NEW' badge from upgrade guide for 0.1.0-beta.22
Adammatthiesen e827d7c
fix(docs): remove OAuth environment variables reference for clarity
Adammatthiesen abae86c
Mark plugins as released in package catalog: Auth0, Discord, GitHub, …
Adammatthiesen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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 file contains hidden or 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
36 changes: 36 additions & 0 deletions
36
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-23.mdx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| i18nReady: true | ||
| title: "Upgrade: 0.1.0-beta.23" | ||
| description: Upgrade StudioCMS to Beta.23 | ||
| sidebar: | ||
| label: 0.1.0-beta.23 | ||
| badge: | ||
| text: NEW | ||
| variant: success | ||
| order: 999992 | ||
| --- | ||
|
|
||
| import ReadMore from '~/components/ReadMore.astro' | ||
| import QuickUpdate from '~/components/QuickUpdate.astro' | ||
| import { Aside } from '@astrojs/starlight/components' | ||
|
|
||
| <QuickUpdate /> | ||
|
|
||
| ## Breaking Changes | ||
|
|
||
| - Refactor oAuth: oAuth providers have been modularized into separate plugins. This means that you will need to install the respective plugin for each oAuth provider you want to use. The existing oAuth providers have been moved to their respective plugins: | ||
| - [`@studiocms/auth0` for Auth0][auth0-plugin] | ||
| - [`@studiocms/discord` for Discord][discord-plugin] | ||
| - [`@studiocms/github` for GitHub][github-plugin] | ||
| - [`@studiocms/google` for Google][google-plugin] | ||
|
|
||
| ## Bug fixes | ||
|
|
||
| - Fix sdk: Correct issue where the `CMSSiteConfigId` is undefined during initialization. | ||
| - Fix UserQuickTools Widget: Tweak user quick tools widget and endpoint to prevent an actual 400 error on the user browser | ||
|
|
||
| {/* Links */} | ||
| [auth0-plugin]: /en/package-catalog/studiocms-plugins/studiocms-auth0/ | ||
| [discord-plugin]: /en/package-catalog/studiocms-plugins/studiocms-discord/ | ||
| [github-plugin]: /en/package-catalog/studiocms-plugins/studiocms-github/ | ||
| [google-plugin]: /en/package-catalog/studiocms-plugins/studiocms-google/ | ||
39 changes: 39 additions & 0 deletions
39
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-auth0.mdx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| i18nReady: true | ||
| title: "@studiocms/auth0" | ||
| type: integration | ||
| catalogEntry: studiocms-auth0 | ||
| description: "StudioCMS Auth0 Integration" | ||
| sidebar: | ||
| badge: | ||
| text: 'Plugin' | ||
| variant: 'tip' | ||
| --- | ||
|
|
||
| import { PackageManagers } from 'starlight-package-managers' | ||
| import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; | ||
|
|
||
| This plugin integrates Auth0 as an OAuth provider for StudioCMS, enabling authentication via Auth0. It sets up the necessary configuration, including required environment variables and endpoint paths. | ||
|
|
||
| ## Usage | ||
|
|
||
| Add this plugin in your StudioCMS config. (`studiocms.config.mjs`) | ||
|
|
||
| ```ts title="studiocms.config.mjs" | ||
| import { defineStudioCMSConfig } from 'studiocms/config'; | ||
| import auth0 from '@studiocms/auth0'; | ||
|
|
||
| export default defineStudioCMSConfig({ | ||
| // other options here | ||
| plugins: [auth0()] | ||
| }); | ||
| ``` | ||
|
|
||
| ## Required ENV Variables | ||
|
|
||
| ```sh title=".env" | ||
| CMS_AUTH0_CLIENT_ID=<your-client-id> | ||
| CMS_AUTH0_CLIENT_SECRET=<your-client-secret> | ||
| CMS_AUTH0_DOMAIN=<your-domain> | ||
| CMS_AUTH0_REDIRECT_URI=<your-redirect-uri> | ||
| ``` |
38 changes: 38 additions & 0 deletions
38
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-discord.mdx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| i18nReady: true | ||
| title: "@studiocms/discord" | ||
| type: integration | ||
| catalogEntry: studiocms-discord | ||
| description: "StudioCMS Discord Integration" | ||
| sidebar: | ||
| badge: | ||
| text: 'Plugin' | ||
| variant: 'tip' | ||
| --- | ||
|
|
||
| import { PackageManagers } from 'starlight-package-managers' | ||
| import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; | ||
|
|
||
| This plugin integrates Discord as an OAuth authentication provider for StudioCMS. It sets up the necessary configuration, including the required environment variables and OAuth endpoints. | ||
|
|
||
| ## Usage | ||
|
|
||
| Add this plugin in your StudioCMS config. (`studiocms.config.mjs`) | ||
|
|
||
| ```ts title="studiocms.config.mjs" | ||
| import { defineStudioCMSConfig } from 'studiocms/config'; | ||
| import discord from '@studiocms/discord'; | ||
|
|
||
| export default defineStudioCMSConfig({ | ||
| // other options here | ||
| plugins: [discord()] | ||
| }); | ||
| ``` | ||
|
|
||
| ## Required ENV Variables | ||
|
|
||
| ```sh title=".env" | ||
| CMS_DISCORD_CLIENT_ID=<your-client-id> | ||
| CMS_DISCORD_CLIENT_SECRET=<your-client-secret> | ||
| CMS_DISCORD_REDIRECT_URI=<your-redirect-uri> | ||
| ``` |
38 changes: 38 additions & 0 deletions
38
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-github.mdx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| i18nReady: true | ||
| title: "@studiocms/github" | ||
| type: integration | ||
| catalogEntry: studiocms-github | ||
| description: "StudioCMS GitHub Integration" | ||
| sidebar: | ||
| badge: | ||
| text: 'Plugin' | ||
| variant: 'tip' | ||
| --- | ||
|
|
||
| import { PackageManagers } from 'starlight-package-managers' | ||
| import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; | ||
|
|
||
| This plugin integrates GitHub as an OAuth authentication provider for StudioCMS. It sets up the necessary authentication service, including the provider's name, endpoint paths and required environment variables. | ||
|
|
||
| ## Usage | ||
|
|
||
| Add this plugin in your StudioCMS config. (`studiocms.config.mjs`) | ||
|
|
||
| ```ts title="studiocms.config.mjs" | ||
| import { defineStudioCMSConfig } from 'studiocms/config'; | ||
| import github from '@studiocms/github'; | ||
|
|
||
| export default defineStudioCMSConfig({ | ||
| // other options here | ||
| plugins: [github()] | ||
| }); | ||
| ``` | ||
|
|
||
| ## Required ENV Variables | ||
|
|
||
| ```sh title=".env" | ||
| CMS_GITHUB_CLIENT_ID=<your-client-id> | ||
| CMS_GITHUB_CLIENT_SECRET=<your-client-secret> | ||
| CMS_GITHUB_REDIRECT_URI=<your-redirect-uri> | ||
| ``` |
38 changes: 38 additions & 0 deletions
38
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-google.mdx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| i18nReady: true | ||
| title: "@studiocms/google" | ||
| type: integration | ||
| catalogEntry: studiocms-google | ||
| description: "StudioCMS Google Integration" | ||
| sidebar: | ||
| badge: | ||
| text: 'Plugin' | ||
| variant: 'tip' | ||
| --- | ||
|
|
||
| import { PackageManagers } from 'starlight-package-managers' | ||
| import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components'; | ||
|
|
||
| This plugin integrates Google OAuth authentication into StudioCMS. It defines the necessary configuration, including the required environment variables, OAuth provider details, and the endpoint paths for authentication. | ||
|
|
||
| ## Usage | ||
|
|
||
| Add this plugin in your StudioCMS config. (`studiocms.config.mjs`) | ||
|
|
||
| ```ts title="studiocms.config.mjs" | ||
| import { defineStudioCMSConfig } from 'studiocms/config'; | ||
| import google from '@studiocms/google'; | ||
|
|
||
| export default defineStudioCMSConfig({ | ||
| // other options here | ||
| plugins: [google()] | ||
| }); | ||
| ``` | ||
|
|
||
| ## Required ENV Variables | ||
|
|
||
| ```sh title=".env" | ||
| CMS_GOOGLE_CLIENT_ID=<your-client-id> | ||
| CMS_GOOGLE_CLIENT_SECRET=<your-client-secret> | ||
| CMS_GOOGLE_REDIRECT_URI=<your-redirect-uri> | ||
| ``` |
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.