docs: document shipped ModSecurity versions in README and wire Renovate to keep them updated#424
docs: document shipped ModSecurity versions in README and wire Renovate to keep them updated#424Copilot wants to merge 2 commits into
Conversation
📝 WalkthroughWalkthroughThis PR updates documentation with specific ModSecurity and base image versions for nginx and Apache httpd, replacing generic "latest stable" terminology. It then adds Renovate custom managers to automatically extract and track these versions from the README against GitHub releases. ChangesModSecurity Version Documentation and Automation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
Agent-Logs-Url: https://github.com/coreruleset/modsecurity-crs-docker/sessions/9213f7c1-e54f-4974-a7d7-4515d8de5999 Co-authored-by: fzipi <3012076+fzipi@users.noreply.github.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
renovate.json (1)
101-118: ⚡ Quick winAdd
extractVersionTemplateto prevent "v" prefix in version replacements.Both ModSecurity v3 (line 101) and v2 (line 114) configurations use
github-releasesdatasource, which tags releases asvX.Y.Z. WithoutextractVersionTemplate, Renovate will write the "v" prefix directly into the captured numeric slot. AddextractVersionTemplateto strip it during replacement.Suggested patch
{ "description": "Docs: ModSecurity v3", "customType": "regex", "managerFilePatterns": [ "/^README\\.md$/" ], "matchStrings": [ ".*ModSecurity v(?<currentValue>\\d+\\.\\d+\\.\\d+) on Nginx" ], + "extractVersionTemplate": "^v?(?<version>\\d+\\.\\d+\\.\\d+)$", "depNameTemplate": "ModSecurity3", "packageNameTemplate": "owasp-modsecurity/ModSecurity", "datasourceTemplate": "github-releases" }, { "description": "Docs: ModSecurity v2", "customType": "regex", "managerFilePatterns": [ "/^README\\.md$/" ], "matchStrings": [ ".*ModSecurity v(?<currentValue>\\d+\\.\\d+\\.\\d+) on Apache" ], + "extractVersionTemplate": "^v?(?<version>\\d+\\.\\d+\\.\\d+)$", "depNameTemplate": "ModSecurity2", "packageNameTemplate": "owasp-modsecurity/ModSecurity", "datasourceTemplate": "github-releases" },🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@renovate.json` around lines 101 - 118, The Renovate rules for ModSecurity3 and ModSecurity2 (entries identified by depNameTemplate "ModSecurity3" and "ModSecurity2" and using datasourceTemplate "github-releases") need an extractVersionTemplate added to strip the leading "v" from GitHub release tags so numeric versions are used in replacements; update both rule objects to include an extractVersionTemplate that matches and captures the numeric X.Y.Z portion (removing the "v" prefix) so renovate will write plain semantic versions into the captured currentValue.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@renovate.json`:
- Around line 101-118: The Renovate rules for ModSecurity3 and ModSecurity2
(entries identified by depNameTemplate "ModSecurity3" and "ModSecurity2" and
using datasourceTemplate "github-releases") need an extractVersionTemplate added
to strip the leading "v" from GitHub release tags so numeric versions are used
in replacements; update both rule objects to include an extractVersionTemplate
that matches and captures the numeric X.Y.Z portion (removing the "v" prefix) so
renovate will write plain semantic versions into the captured currentValue.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 3607a228-c5d4-4e60-b5c8-f4f9726f5f8d
📒 Files selected for processing (2)
README.mdrenovate.json
The README’s OS variant section listed web server and CRS versions but not the exact ModSecurity releases being shipped. This change adds explicit ModSecurity versions and extends Renovate docs regex managers so those README values stay in sync with upstream ModSecurity releases.
README: OS variants now include concrete ModSecurity releases
ModSecurity v3.0.15ModSecurity v2.9.13Renovate: added docs managers for ModSecurity version strings
Docs: ModSecurity v3manager for the nginx line inREADME.mdDocs: ModSecurity v2manager for the Apache line inREADME.mdowasp-modsecurity/ModSecurityGitHub releases and update captured semver in place{ "description": "Docs: ModSecurity v3", "matchStrings": [ ".*ModSecurity v(?<currentValue>\\d+\\.\\d+\\.\\d+) on Nginx" ], "depNameTemplate": "ModSecurity3", "packageNameTemplate": "owasp-modsecurity/ModSecurity", "datasourceTemplate": "github-releases" }Summary by CodeRabbit
Documentation
Chores