-
Notifications
You must be signed in to change notification settings - Fork 40
Add release notes for 4.4.3 #2045
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
Conversation
|
Caution Review failedThe pull request is closed. Summary by CodeRabbit
WalkthroughDocs and metadata updated for release 4.4.3: release version bumped, new release-notes file added, Javadoc links switched to HTTPS and consolidated to use Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Studio as "Crafter Studio"
participant Disk as "Data Directory"
participant Notifier as "Notifier"
participant API as "getDiskUsage API"
Studio->>Disk: monitor data directory usage
Disk-->>Studio: return usage metrics
Studio->>Notifier: evaluate thresholds → send alerts if exceeded
Studio->>API: serve getDiskUsage requests
API-->>Studio: deliver current disk usage metrics
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 (4)
source/conf.py (2)
30-33: Unify version constants to avoid drift
releaseis now hard-coded to4.4.3whileversionremains"current".
If other files compute URLs or paths from different variables (e.g.extlinksusesversion, Javadoc usesjavadoc_version), the numbers can easily diverge in the next bump.Consider defining a single
latest_version = "4.4.3"constant and derivingrelease,javadoc_version, and any other helpers from it (or vice-versa). That removes the chance of missing one spot during the next upgrade.
299-303: Serve Javadoc over HTTPS
javadoc_base = 'http://javadoc.craftercms.org/'still uses http.
Becausejavadoc_versionwas bumped here, this is a good opportunity to switch the scheme to HTTPS to prevent mixed-content warnings in the rendered docs.-javadoc_base = 'http://javadoc.craftercms.org/' +javadoc_base = 'https://javadoc.craftercms.org/'source/release-notes/4-4-3.rst (2)
25-26: Typo: “HTTPs” → “HTTPS”Smart Git in Git HTTPs server is now supported
The conventional capitalization is HTTPS (all caps, no lowercase “s”).
-* `Smart Git in Git HTTPs server is now supported <https://github.com/craftercms/craftercms/issues/8268>`__ |br| +* `Smart Git in Git HTTPS server is now supported <https://github.com/craftercms/craftercms/issues/8268>`__ |br|
16-18: Heading pluralisationThe section title “New Feature” introduces multiple bullets. Consider switching to “New Features” for grammatical agreement.
-^^^^^^^^^^^ -New Feature -^^^^^^^^^^^ +^^^^^^^^^^^^ +New Features +^^^^^^^^^^^^
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
source/conf.py(2 hunks)source/index.rst(2 hunks)source/release-notes/4-4-3.rst(1 hunks)source/release-notes/index.rst(2 hunks)source/support.rst(2 hunks)
🔇 Additional comments (4)
source/support.rst (1)
24-29: Replace “TBD” with the actual release date before shippingThe table shows
4.4.3 (TBD, 2025).
LeavingTBDin a published support matrix can confuse readers and automated parsers that rely on a concrete release date.Please update the date (or add a precise ISO format) immediately before the public release cut.
source/release-notes/index.rst (1)
12-16: Release note include order looks goodThe new
.. include:: /release-notes/4-4-3.rstwas added at the top, keeping the list in descending order. No further issues spotted.source/index.rst (1)
70-75: Landing page version bump verifiedThe “Latest CrafterCMS Release” section correctly advertises 4.4.3 and stays consistent with
source/conf.py.
No action needed.source/release-notes/4-4-3.rst (1)
19-23: Anchor existence / path sanity checkThe text references the anchor ``:ref:
studio-disk-monitoring``` and an HTML file at../_static/api/studio.html#tag/monitoring/operation/getDiskUsage`.Please confirm that:
studio-disk-monitoringis actually defined somewhere in the docs, otherwise Sphinx will emit a broken reference.- The
_static/api/studio.htmlfile is present in the build or copied viaremoteliteralinclude.Broken links in release notes are highly visible – worth an extra build run before merge.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/contribute/acknowledgements.rst(2 hunks)
🔇 Additional comments (1)
source/contribute/acknowledgements.rst (1)
2-2: LGTM: last-updated bumped to 4.4.3Change aligns with the 4.4.3 release.
Ticket reference or full description of what's in the PR
Add release notes for 4.4.3