add beta.21 upgrade guide#146
Conversation
WalkthroughA new upgrade guide document for StudioCMS version 0.1.0-beta.21 was added, detailing bug fixes and a breaking change regarding password hashing. The subproject dependency for Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant StudioCMS
User->>Docs: Accesses upgrade guide for 0.1.0-beta.21
Docs->>User: Displays bug fixes and breaking change notice
User->>StudioCMS: Updates StudioCMS and applies password update as advised
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Poem
Note ⚡️ Unit Test Generation - BetaCodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (2)
21-22: Polish wording & casing in the single bullet point
Small editorial tweaks improve readability and keep style consistent with the other upgrade guides (sentence-case, parallel wording, abbreviations in code-font where appropriate).-- Implement fixes for First-time-setup, auth API routes and css for font, and markdown pageType config. +- Fixes for first-time setup, authentication API routes, font CSS, and Markdown `pageType` configuration.
23-25: Use fully-qualified version strings for clarity
Elsewhere in the docs we prefix version tags with the full semver (e.g.0.1.0-beta.16). Updating the aside maintains consistency and avoids confusion between branches with the same beta number.-Please note that in `beta.16` we introduced a breaking change with the password hashing algorithm. While previous passwords will still work, we recommend that users update their passwords after upgrading to `beta.21`. +Please note that in `0.1.0-beta.16` we introduced a breaking change with the password-hashing algorithm. While existing passwords still work, we recommend users update their passwords after upgrading to `0.1.0-beta.21`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx(1 hunks)studiocms(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1)
Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
🔇 Additional comments (2)
studiocms (1)
1-1: Confirm the submodule pointer is pinned to the officialv0.1.0-beta.21release tag.The hash
6816ab0looks plausible, but without an explicit tag reference we can’t be sure this commit won’t be force-moved or replaced.
Please double-check that:
- The referenced commit is the exact commit tagged as
v0.1.0-beta.21(or the SHA of the annotated tag);- A lightweight tag or branch move will not break reproducible builds for downstream consumers.
If it isn’t the release tag, consider retargeting the submodule to the tag itself rather than an arbitrary SHA.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1)
27-34: Run link checker before merge
Several reference links ([image-service],[web-vitals-guide], etc.) rely on legacy paths that occasionally change. A quicknpm run check:links(or equivalent) will catch any drift introduced since the last release.
3 participants
Description
Summary by CodeRabbit