Added release template. #1851
Added release template. #1851
Conversation
WalkthroughThe changes update the documentation and configuration for the release process. The Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
.vortex/.ahoy.yml (1)
22-27:docsanddocs-servenow execute the same command – semantic overlap
Changingdocs-servetoyarn … startmakes it identical to thedocstarget, losing the former distinction between development server vs serving the built static output. If the project still needs a command to serve the pre-built documentation (oftenyarn … serve), consider restoring it or renaming the commands to reflect their true purpose.- yarn --cwd=docs run start + # If the intent is to serve the already-built static files, + # keep using the dedicated `serve` script; otherwise drop the + # separate target to avoid duplication. + yarn --cwd=docs run serve
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.vortex/.ahoy.yml(1 hunks).vortex/docs/content/contributing/maintenance/release.mdx(1 hunks).vortex/docs/content/contributing/maintenance/release_template.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
.vortex/docs/content/contributing/maintenance/release.mdx (1)
Learnt from: CR
PR: drevops/vortex#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T15:00:28.327Z
Learning: Node.js dependencies are updated in theme directories via RenovateBot
.vortex/docs/content/contributing/maintenance/release_template.md (3)
Learnt from: CR
PR: drevops/vortex#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T15:00:28.327Z
Learning: Composer dependencies are updated automatically with compatibility checks via RenovateBot
Learnt from: CR
PR: drevops/vortex#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T15:00:28.327Z
Learning: Docker images are updated for containers via RenovateBot
Learnt from: CR
PR: drevops/vortex#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T15:00:28.327Z
Learning: Node.js dependencies are updated in theme directories via RenovateBot
🪛 LanguageTool
.vortex/docs/content/contributing/maintenance/release_template.md
[grammar] ~1-~1: Use correct spacing
Context: ## What's new since [PREVIOUS_VERSION] [SHORT SUMMARY] ## Notable changes Non...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...'s new since [PREVIOUS_VERSION] [SHORT SUMMARY] ## Notable changes None --- ## 💥 Breaki...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...S_VERSION] [SHORT SUMMARY] ## Notable changes None --- ## 💥 Breaking changes None ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ...able changes None --- ## 💥 Breaking changes None --- ## 💧 Drupal ### New feature...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: Use correct spacing
Context: ...# 💥 Breaking changes None --- ## 💧 Drupal ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~19-~19: Use correct spacing
Context: ...anges None --- ## 💧 Drupal ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~23-~23: Use correct spacing
Context: ... 💧 Drupal ### New features None ### Fixes None ### Updates None ## ☁️ Hosting ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~27-~27: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## ☁️ Hosting ### New features ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~32-~32: Use correct spacing
Context: ... Fixes None ### Updates None ## ☁️ Hosting ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~34-~34: Use correct spacing
Context: ... Updates None ## ☁️ Hosting ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~38-~38: Use correct spacing
Context: ...☁️ Hosting ### New features None ### Fixes None ### Updates None ## 🏗 Continuo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~42-~42: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## 🏗 Continuous Integration ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~47-~47: Use correct spacing
Context: ...e ### Updates None ## 🏗 Continuous Integration ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~49-~49: Use correct spacing
Context: ... ## 🏗 Continuous Integration ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~53-~53: Use correct spacing
Context: ...ntegration ### New features None ### Fixes None ### Updates None ## 💻 Local De...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~57-~57: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## 💻 Local Development and conta...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~62-~62: Use correct spacing
Context: ...es None ## 💻 Local Development and containers ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~64-~64: Use correct spacing
Context: ...cal Development and containers ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~68-~68: Use correct spacing
Context: ...containers ### New features None ### Fixes None ### Updates None ## 🛠️ Tools ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~72-~72: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## 🛠️ Tools ### New features N...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~77-~77: Use correct spacing
Context: ...Fixes None ### Updates None ## 🛠️ Tools ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~79-~79: Use correct spacing
Context: ...# Updates None ## 🛠️ Tools ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~83-~83: Use correct spacing
Context: ... 🛠️ Tools ### New features None ### Fixes None ### Updates None ## ⚙️ Workflow...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~87-~87: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## ⚙️ Workflow ### New features ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~92-~92: Use correct spacing
Context: ... Fixes None ### Updates None ## ⚙️ Workflow ### New features None ### Fixes None ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~94-~94: Use correct spacing
Context: ...Updates None ## ⚙️ Workflow ### New features None ### Fixes None ### Updates None...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~98-~98: Use correct spacing
Context: ...️ Workflow ### New features None ### Fixes None ### Updates None ## 🌀 Vortex ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~102-~102: Use correct spacing
Context: ...ew features None ### Fixes None ### Updates None ## 🌀 Vortex - 📖 Documentation:...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~107-~107: Use correct spacing
Context: ... Fixes None ### Updates None ## 🌀 Vortex - 📖 Documentation: - - 🎛️ Installer: ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~109-~109: There might be a mistake here.
Context: ... ### Updates None ## 🌀 Vortex - 📖 Documentation: - - 🎛️ Installer: - - 🔧 Vortex mainte...
(QB_NEW_EN_OTHER)
[grammar] ~112-~112: There might be a mistake here.
Context: ... Vortex - 📖 Documentation: - - 🎛️ Installer: - - 🔧 Vortex maintenance: - --- ## 📋...
(QB_NEW_EN_OTHER)
[grammar] ~115-~115: There might be a mistake here.
Context: ... - - 🎛️ Installer: - - 🔧 Vortex maintenance: - --- ## 📋 Release checklist - [ ] Updated ...
(QB_NEW_EN_OTHER)
[grammar] ~120-~120: Use correct spacing
Context: ...ex maintenance: - --- ## 📋 Release checklist - [ ] Updated all dependencies outside of ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[style] ~122-~122: This phrase is redundant. Consider using “outside”.
Context: ...ecklist - [ ] Updated all dependencies outside of the schedule - [ ] Updated container im...
(OUTSIDE_OF)
[grammar] ~122-~122: There might be a mistake here.
Context: ...Updated all dependencies outside of the schedule - [ ] Updated container images to the late...
(QB_NEW_EN_OTHER)
[grammar] ~123-~123: There might be a mistake here.
Context: ...latest versions and checked that @see links - [ ] Updated PHP version in `composer.jso...
(QB_NEW_EN_OTHER)
[grammar] ~130-~130: Use correct spacing
Context: ...s/build-test-deploy.yml`. - [ ] Updated documentation. --- Full Changelog: https://github.com/dre...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~134-~134: There might be a problem here.
Context: ...ocumentation. --- Full Changelog: [PREVIOUS_VERSION]...[NEW_VERSION] @AlexSkrypnyk, @renovate[bot] and [renovate[bot]](https://github.com/apps...
(QB_NEW_EN_MERGED_MATCH)
🪛 markdownlint-cli2 (0.17.2)
.vortex/docs/content/contributing/maintenance/release_template.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
31-31: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
46-46: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
61-61: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
76-76: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
91-91: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
106-106: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
109-109: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
109-109: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
112-112: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
112-112: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
115-115: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
115-115: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
134-134: Bare URL used
(MD034, no-bare-urls)
⏰ 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). (13)
- GitHub Check: build (1)
- GitHub Check: build (0)
- GitHub Check: vortex-test-deployment (1)
- GitHub Check: vortex-test-deployment (0)
- GitHub Check: vortex-test-workflow (3)
- GitHub Check: vortex-test-workflow (0)
- GitHub Check: vortex-test-workflow (2)
- GitHub Check: vortex-test-workflow (1)
- GitHub Check: vortex-test-common
- GitHub Check: vortex-test-installer (8.4)
- GitHub Check: vortex-test-installer (8.2)
- GitHub Check: vortex-test-installer (8.3)
- GitHub Check: vortex-test-docs
🔇 Additional comments (1)
.vortex/docs/content/contributing/maintenance/release.mdx (1)
17-18: Link path looks good – but verify render in doc site
The relative link to./release_template.mdshould work once both files are in the same directory. Just confirm the MDX renderer keeps the.mdextension intact.
| ## What's new since [PREVIOUS_VERSION] | ||
|
|
||
| [SHORT SUMMARY] |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add a mandatory H1 heading before any other content
Markdown-lint (MD041) fails because the file does not start with a top-level heading. This will break the docs build in CI.
+# Release [NEW_VERSION]
+
## What's new since [PREVIOUS_VERSION]
[SHORT SUMMARY]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## What's new since [PREVIOUS_VERSION] | |
| [SHORT SUMMARY] | |
| # Release [NEW_VERSION] | |
| ## What's new since [PREVIOUS_VERSION] | |
| [SHORT SUMMARY] |
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Use correct spacing
Context: ## What's new since [PREVIOUS_VERSION] [SHORT SUMMARY] ## Notable changes Non...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...'s new since [PREVIOUS_VERSION] [SHORT SUMMARY] ## Notable changes None --- ## 💥 Breaki...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🪛 markdownlint-cli2 (0.17.2)
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In .vortex/docs/content/contributing/maintenance/release_template.md at lines 1
to 3, add a mandatory top-level heading (H1) as the very first line of the file
before any other content to satisfy markdown-lint MD041 and prevent CI build
failures.
| ## 📋 Release checklist | ||
|
|
||
| - [ ] Updated all dependencies outside of the schedule | ||
| - [ ] Updated container images to the latest versions and checked that `@see` links | ||
| - [ ] Updated PHP version in `composer.json` for `config.platform`. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Tighten wording in checklist item
“outside of the schedule” is redundant and flagged by GrammarTool.
-- [ ] Updated all dependencies outside of the schedule
+- [ ] Updated all dependencies outside the schedule📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 📋 Release checklist | |
| - [ ] Updated all dependencies outside of the schedule | |
| - [ ] Updated container images to the latest versions and checked that `@see` links | |
| - [ ] Updated PHP version in `composer.json` for `config.platform`. | |
| ## 📋 Release checklist | |
| - [ ] Updated all dependencies outside the schedule | |
| - [ ] Updated container images to the latest versions and checked that `@see` links | |
| - [ ] Updated PHP version in `composer.json` for `config.platform`. |
🧰 Tools
🪛 LanguageTool
[grammar] ~120-~120: Use correct spacing
Context: ...ex maintenance: - --- ## 📋 Release checklist - [ ] Updated all dependencies outside of ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[style] ~122-~122: This phrase is redundant. Consider using “outside”.
Context: ...ecklist - [ ] Updated all dependencies outside of the schedule - [ ] Updated container im...
(OUTSIDE_OF)
[grammar] ~122-~122: There might be a mistake here.
Context: ...Updated all dependencies outside of the schedule - [ ] Updated container images to the late...
(QB_NEW_EN_OTHER)
[grammar] ~123-~123: There might be a mistake here.
Context: ...latest versions and checked that @see links - [ ] Updated PHP version in `composer.jso...
(QB_NEW_EN_OTHER)
🤖 Prompt for AI Agents
In .vortex/docs/content/contributing/maintenance/release_template.md around
lines 120 to 124, the phrase "outside of the schedule" in the checklist item is
redundant. Simplify the wording by removing "outside of the schedule" to make
the checklist clearer and more concise.
| **Full Changelog**: https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION] | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Avoid bare URL – convert to a proper Markdown link
MD034 reports a violation; using an explicit link improves readability.
-**Full Changelog**: https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION]
+**Full Changelog**: [Compare changes](https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION])📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Full Changelog**: https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION] | |
| **Full Changelog**: [Compare changes](https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION]) |
🧰 Tools
🪛 LanguageTool
[grammar] ~134-~134: There might be a problem here.
Context: ...ocumentation. --- Full Changelog: [PREVIOUS_VERSION]...[NEW_VERSION] @AlexSkrypnyk, @renovate[bot] and [renovate[bot]](https://github.com/apps...
(QB_NEW_EN_MERGED_MATCH)
🪛 markdownlint-cli2 (0.17.2)
134-134: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In .vortex/docs/content/contributing/maintenance/release_template.md at lines
134 to 135, the full changelog URL is presented as a bare URL which violates
MD034. Replace the bare URL with a proper Markdown link by enclosing the link
text in brackets and the URL in parentheses, for example, use [Full
Changelog](https://github.com/drevops/vortex/compare/[PREVIOUS_VERSION]...[NEW_VERSION])
to improve readability and comply with Markdown standards.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1851 +/- ##
===========================================
+ Coverage 74.57% 75.22% +0.65%
===========================================
Files 78 84 +6
Lines 4735 4860 +125
Branches 0 35 +35
===========================================
+ Hits 3531 3656 +125
Misses 1204 1204 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit
Documentation
Chores