Skip to content

feat: add upgrade guide for StudioCMS Beta.29#172

Merged
Adammatthiesen merged 2 commits into
mainfrom
beta.29
Nov 9, 2025
Merged

feat: add upgrade guide for StudioCMS Beta.29#172
Adammatthiesen merged 2 commits into
mainfrom
beta.29

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen commented Nov 7, 2025

TODO Before merge:

  • Update deps to 0.1.0-beta.29 once released

Summary by CodeRabbit

  • Documentation

    • Added an upgrade guide for version 0.1.0-beta.29, including a Quick Update and notes on bug fixes & improvements
    • Updated an existing upgrade guide and removed a "NEW" sidebar badge display
  • Chores

    • Bumped package versions and documented dependency updates in the release notes

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 7, 2025

📝 Walkthrough

Walkthrough

Removed a sidebar badge from the 0.1.0-beta.28 upgrade guide, added a new 0.1.0-beta.29 upgrade guide documenting dependency bumps and bug fixes, and updated multiple package versions in package.json to 0.1.0-beta.29 (and @studiocms/ui → 1.0.0-beta.4).

Changes

Cohort / File(s) Summary
Badge removal from existing version guide
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-28.mdx
Removed frontmatter fields badge.text and badge.variant (sidebar badge removed)
New version guide documentation
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-29.mdx
Added new release notes page for 0.1.0-beta.29 with imports (ReadMore, QuickUpdate, Aside), a QuickUpdate usage, and a Bug Fixes & Improvements section documenting dependency updates
Dependency version bumps
package.json
Updated multiple packages from 0.1.0-beta.280.1.0-beta.29 (several @studiocms/* packages and studiocms), and bumped @studiocms/ui from 1.0.0-beta.31.0.0-beta.4 (and @withstudiocms/component-registry0.1.0-beta.5)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Check MDX frontmatter correctness and that badge removal is intentional.
  • Verify imports used in the new MDX file are available and renderable.
  • Confirm package.json bumps are consistent and no inadvertent dependency regressions.

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • louisescher
  • dreyfus92
  • RATIU5

Poem

🐰 I hopped through docs to clear a badge away,
A fresh beta guide now greets the day,
Versions bumped, the changelog sings,
I tuck in fixes on quiet wings,
Nibble, hop, and off I play.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding an upgrade guide for StudioCMS Beta.29, which is reflected in the new documentation file and dependency updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch beta.29

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 337cc0f and 051389b.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • package.json (1 hunks)
⏰ 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)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (1)
package.json (1)

25-36: All package versions confirmed as published and available.

Verification confirms:

  • All 9 StudioCMS packages are published at 0.1.0-beta.29 ✓
  • @studiocms/ui at 1.0.0-beta.4 is available ✓
  • @withstudiocms/component-registry at 0.1.0-beta.5 is available ✓

Version bumps are coherent and appropriate for beta releases with exact pinning.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Nov 7, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/upgrade/version-guides/0-1-0-beta-28.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-1-0-beta-29.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@Adammatthiesen Adammatthiesen marked this pull request as ready for review November 7, 2025 21:04
@Adammatthiesen Adammatthiesen requested a review from a team as a code owner November 7, 2025 21:04
@coderabbitai coderabbitai Bot added the i18n label Nov 7, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-29.mdx (2)

1-11: Frontmatter structure is well-configured; minor notes on sidebar ordering.

The frontmatter is properly structured for Starlight documentation with valid i18n and sidebar metadata. However, the sidebar.order: 999986 is unusually specific and may cause unexpected navigation ordering if other guides use similar high values. Consider using a more conventional ordering approach (e.g., sequential numbers or relative positioning) to maintain clarity and avoid conflicts as new guides are added.


13-15: Unused component imports.

The ReadMore (line 13) and Aside (line 15) components are imported but not used in the provided code. If these are not referenced elsewhere in the file, consider removing them to keep the file clean. If they're intended for future content sections, consider adding a clarifying comment.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b0beb48 and 337cc0f.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-28.mdx (0 hunks)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-29.mdx (1 hunks)
💤 Files with no reviewable changes (1)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-28.mdx
🔇 Additional comments (1)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-29.mdx (1)

19-21: Documentation content is appropriately concise for an upgrade guide.

The "Bug Fixes & Improvements" section is lean but suitable for a quick reference upgrade guide. The explicit mention of the @studiocms/ui version bump to address an Astro Picocolors bug is valuable context. Ensure the QuickUpdate component (line 17) provides necessary navigation or additional details to guide users through the upgrade process.

@coderabbitai coderabbitai Bot added the i18n label Nov 9, 2025
@Adammatthiesen Adammatthiesen merged commit 6416a9e into main Nov 9, 2025
8 checks passed
@Adammatthiesen Adammatthiesen deleted the beta.29 branch November 9, 2025 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants