Add release notes for 4.5.0 #2062
Conversation
Summary by CodeRabbit
WalkthroughBumps documentation and Sphinx release metadata to 4.5.0, adds 4.5.0 release notes and breaking-changes entries, updates the embedded Deployer OpenAPI/Redoc spec to 4.5.0 (including minor example/text tweaks), and expands the Studio SEARCH_KEYWORDS validation regex. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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. Comment |
|
@CodeRabbit full review |
✅ Actions performedFull review triggered. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (4)
source/release-notes/4-x-breaking-changes.rst (1)
26-35: Clarify default Groovy sandbox impact and mitigationAdd one line with the exact toggle/override path or property to disable/extend the allowlist per component so users can quickly unblock upgrades.
Suggested addition:
- - CrafterCMS version 4.5.0 added a whitelist for Groovy scripts ... + - CrafterCMS version 4.5.0 added an allowlist (whitelist) for Groovy scripts ... + You can extend it via per‑component configuration (e.g., studio: `studio.groovy.sandbox.whitelist.*`, engine: `engine.groovy.sandbox.whitelist.*`, deployer: `deployer.groovy.sandbox.whitelist.*`).source/index.rst (1)
74-74: Latest version line updatedOK. Consider adding a short note linking to breaking changes for visibility.
-The latest version of CrafterCMS is `version 4.5.0 <https://craftercms.com/download>`__. +The latest version of CrafterCMS is `version 4.5.0 <https://craftercms.com/download>`__. See :ref:`breaking-changes-4-x` before upgrading.source/release-notes/4-5-0.rst (2)
19-23: Groovy sandbox: add quick guidanceAdd a one‑sentence “How to extend the allowlist” pointer per component.
- See :ref:`Deployer Groovy Sandbox <deployer-groovy-sandbox-configuration>`, ... + See :ref:`Deployer Groovy Sandbox <deployer-groovy-sandbox-configuration>`, ... + To allow custom classes/methods, extend the sandbox allowlist in your component’s configuration.
56-57: Capitalize dependency names; optional linksMinor copy edit.
- - Spring security to version 6.5.4 - - Mariadb4j to version 3.1.0.5 + - Spring Security to version 6.5.4 + - MariaDB4j to version 3.1.0.5Optionally link to changelogs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
source/_static/api/deployer.html(2 hunks)source/conf.py(1 hunks)source/index.rst(2 hunks)source/reference/modules/studio.rst(2 hunks)source/release-notes/4-5-0.rst(1 hunks)source/release-notes/4-x-breaking-changes.rst(3 hunks)source/release-notes/index.rst(2 hunks)source/support.rst(2 hunks)
🔇 Additional comments (11)
source/support.rst (1)
2-2: LGTM on metadata bump:last-updated set to 4.5.0 looks consistent with the PR intent.
source/reference/modules/studio.rst (1)
2-2: LGTM on metadata bump:last-updated updated to 4.5.0 aligns with this release.
source/conf.py (1)
32-32: Version bump looks good — verify 4.5.0 Javadoc is published & reachableLocation: source/conf.py:32 — release='4.5.0' flows into extlinks. I checked https://javadoc.craftercms.org/4.5.0 (index and package pages) — all returned HTTP 403 (Forbidden), not 200. Confirm the 4.5.0 Javadoc is published and publicly accessible or update extlinks / revert the bump.
source/_static/api/deployer.html (1)
413-415: Version banner correctly reflects 4.5.0Header and displayed version are in sync.
source/release-notes/4-x-breaking-changes.rst (1)
2-2: Meta updated to 4.5.0Good.
source/index.rst (1)
2-2: Meta bump to 4.5.0Looks good.
source/release-notes/index.rst (2)
2-2: Meta bump to 4.5.0OK.
14-15: Include 4.5.0 at topOrdered correctly.
source/release-notes/4-5-0.rst (3)
24-26: Enterprise badge and cache detailsConfirm the |enterpriseOnly| substitution renders and add a link to the enterprise caching doc.
- Improved startup and first page load speeds by using Redis/ValKey as a cache in front of S3. + Improved startup and first page load speeds by using Redis/ValKey as a cache in front of S3. See :ref:`enterprise-caching`.
30-37: Search connection pool and default filtersGood callouts; verify anchors exist.
45-49: Property name and linksConfirm the property key is exactly
studio.validation.regex.SEARCH_KEYWORDSand that the referenced sections exist.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/support.rst (1)
24-28: Make series label styling consistent; confirm “Latest” policy for unreleased series.
- Only 4.5 is a hyperlink; other series are plain text. Suggest making 4.5 plain for consistency (or link all series).
Apply to standardize styling:
- * - `4.5 <https://craftercms.com/download>`__ + * - 4.5Also, confirm whether showing “Latest: 4.5.0 (TBD, 2025)” pre‑release matches your Support page policy. If not, consider “TBD” or “—” until GA.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/support.rst(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-23T14:20:52.668Z
Learnt from: alhambrav
PR: craftercms/docs#2062
File: source/release-notes/4-5-0.rst:7-7
Timestamp: 2025-09-23T14:20:52.668Z
Learning: In CrafterCMS release notes files, "Released *TBD, 2025*" placeholders are intentionally used during release preparation phase. The actual release date is only set once the product is officially released, not during the preparation phase.
Applied to files:
source/support.rst
🔇 Additional comments (2)
source/support.rst (2)
2-2: Version bump looks correct.
:last-updated set to 4.5.0 aligns with the new 4.5 row below.
29-33: 4.4 row: statuses should not be TBD; also, prior “Latest” issue is resolved.
- Good: “Latest” now correctly shows 4.4.4 (resolves the earlier comment).
- Suggest replacing “:green:
TBD” with explicit statuses (likely “:green:Active”) unless you intend to set end dates.Proposed update:
- - :green:`TBD` - - :green:`TBD` + - :green:`Active` + - :green:`Active`
1 participant
Ticket reference or full description of what's in the PR
Add release notes for 4.5.0