Skip to content

Updated Renovate docs.#2361

Merged
AlexSkrypnyk merged 1 commit intomainfrom
feature/update-renovate-docs
Mar 12, 2026
Merged

Updated Renovate docs.#2361
AlexSkrypnyk merged 1 commit intomainfrom
feature/update-renovate-docs

Conversation

@AlexSkrypnyk
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk commented Mar 12, 2026

Summary by CodeRabbit

  • Documentation
    • Reorganized update management documentation with structured "How updates are organized" section
    • Added comprehensive tables outlining update rules for Drupal, PHP, JavaScript, container images, and GitHub Actions
    • Introduced "Disabled updates" section with explanations for manually maintained components
    • Enhanced self-hosted vs GitHub app setup guidance with expanded environment and debugging details

@coderabbitai
Copy link

coderabbitai bot commented Mar 12, 2026

Walkthrough

Reorganized Renovate documentation from a feature-list format to a structured policy format, introducing an "How updates are organized" section with tabular rules for different package types (Drupal core, contrib, JS, container images, GitHub Actions) and a "Disabled updates" table explaining excluded groups.

Changes

Cohort / File(s) Summary
Renovate Documentation Restructure
.vortex/docs/content/tools/renovate.mdx
Replaced features list (items 1–9) with "How updates are organized" section containing an Update rules table (5 package groups) and Disabled updates table. Expanded self-hosted vs GitHub app guidance with environment variables, manual trigger instructions, and debug logging details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 A Rabbit's Ode to Clearer Rules

Once chaotic features scattered wide,
Now tables stand with organized pride,
Update groups in rows aligned so neat,
Documentation's rebirth, oh so sweet! 📋✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Updated Renovate docs' is vague and generic, using a broad term that doesn't convey the specific nature or scope of the documentation changes made. Consider a more descriptive title that reflects the key changes, such as 'Reorganize Renovate docs with update rules and disabled updates tables' or 'Refactor Renovate documentation to structured tabular format'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/update-renovate-docs

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

Copy link

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.vortex/docs/content/tools/renovate.mdx:
- Around line 15-16: Clarify that the `assignees` field referenced on the line
about Renovate is part of Renovate's configuration (e.g., the repository-level
renovate.json) by updating the sentence to explicitly say something like
"Assignees can be configured in your Renovate configuration (e.g., the
repository's renovate.json)"; reference the `assignees` field name and the
renovate.json file so readers know where to set it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ad837515-511f-4c5c-bd55-09a7789bd6b8

📥 Commits

Reviewing files that changed from the base of the PR and between 0b68239 and cf151d3.

📒 Files selected for processing (1)
  • .vortex/docs/content/tools/renovate.mdx

Comment on lines +15 to +16
All Renovate PRs use the branch prefix `deps/` and are labeled `Dependencies`.
Assignees can be configured in the `assignees` field.
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Consider clarifying where the assignees field is located.

Line 16 mentions the assignees field but doesn't specify where it should be configured. Adding a reference to renovate.json would help users unfamiliar with Renovate configuration.

📝 Suggested clarification
 All Renovate PRs use the branch prefix `deps/` and are labeled `Dependencies`.
-Assignees can be configured in the `assignees` field.
+Assignees can be configured in the `assignees` field in `renovate.json`.
📝 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.

Suggested change
All Renovate PRs use the branch prefix `deps/` and are labeled `Dependencies`.
Assignees can be configured in the `assignees` field.
All Renovate PRs use the branch prefix `deps/` and are labeled `Dependencies`.
Assignees can be configured in the `assignees` field in `renovate.json`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.vortex/docs/content/tools/renovate.mdx around lines 15 - 16, Clarify that
the `assignees` field referenced on the line about Renovate is part of
Renovate's configuration (e.g., the repository-level renovate.json) by updating
the sentence to explicitly say something like "Assignees can be configured in
your Renovate configuration (e.g., the repository's renovate.json)"; reference
the `assignees` field name and the renovate.json file so readers know where to
set it.

@github-actions
Copy link

Code Coverage Report:
  2026-03-12 03:20:34

 Summary:
  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (189/189)

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-03-12 03:21:43

 Summary:
  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (189/189)

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-03-12 03:25:11

 Summary:
  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (189/189)

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-03-12 03:25:18

 Summary:
  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (189/189)

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.69%. Comparing base (0b68239) to head (cf151d3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2361      +/-   ##
==========================================
- Coverage   79.19%   78.69%   -0.50%     
==========================================
  Files         125      118       -7     
  Lines        6589     6430     -159     
  Branches       44        0      -44     
==========================================
- Hits         5218     5060     -158     
+ Misses       1371     1370       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk merged commit c80656a into main Mar 12, 2026
43 of 45 checks passed
@github-project-automation github-project-automation bot moved this from BACKLOG to Release queue in Vortex Mar 12, 2026
@AlexSkrypnyk AlexSkrypnyk deleted the feature/update-renovate-docs branch March 12, 2026 04:06
@AlexSkrypnyk AlexSkrypnyk added this to the 1.37.0 milestone Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Released in 1.37.0

Development

Successfully merging this pull request may close these issues.

1 participant