docs: update PXC deprecation notices to link to mgr-docs migration guide#28
docs: update PXC deprecation notices to link to mgr-docs migration guide#28
Conversation
- Add mysql-mgr site entry to sites.yaml (version 4.3) - Replace internal markdown links with ExternalSiteLink components - Remove condensed migrate-to-mgr guide (comprehensive guide now in mgr-docs) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughFive documentation pages were updated to add deprecation warnings for MySQL-PXC pointing to a MySQL-MGR migration guide, and a new Changes
Sequence Diagram(s)(omitted — changes are documentation and site config only) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@sites.yaml`:
- Around line 4-6: The sed that sets version (s/(version:).*/\1 \"$VERSION\"/)
is too broad and the branch regex release-([0-9]+\.[0-9]+) is fragile; instead
constrain updates to the acp site only (e.g., only modify the version key in the
block where "name: acp" appears) or use a YAML-aware tool (yq) to set
.sites[].version for the acp entry; strengthen branch extraction to accept
release[-/]<semver> variants (e.g., release[-/]([0-9]+(?:\.[0-9]+)*)(?:[-/].*)?)
with validation and fallback, and always escape the derived VERSION before
passing to sed (or use an alternate sed delimiter or printf %s to safely quote
it) so delimiter/slash characters cannot break the substitution.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6f39be5c-879a-4ddf-aea6-3be6b3778b78
📒 Files selected for processing (5)
docs/en/architecture.mdxdocs/en/index.mdxdocs/en/installation.mdxdocs/en/intro.mdxsites.yaml
| - name: mysql-mgr | ||
| base: /mysql-mgr | ||
| version: "4.3" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Confirm how many version keys exist now
rg -n '^\s*version:\s*' sites.yaml
# 2) Locate the failing workflow command and inspect context
rg -n 'sed -i -E "s/\(version:\)\.\*/\\1 \\"\\$VERSION\\"/"|version:|sites.yaml' .github -C 3 || true
# 3) Show whether replacement is globally applied (risk: rewrites multiple sites)
rg -n 's/\(version:\)\.\*/\\1' .github -C 5 || trueRepository: alauda/pxc-docs
Length of output: 2319
🏁 Script executed:
# Get full sites.yaml to understand structure
cat -n sites.yamlRepository: alauda/pxc-docs
Length of output: 273
🏁 Script executed:
# Check if sed with this pattern would match all occurrences
# Simulate the sed behavior on a test file with multiple version: keys
cat > /tmp/test_sed.yaml << 'EOF'
- name: site1
base: /site1
version: "old1"
- name: mysql-mgr
base: /mysql-mgr
version: "old2"
EOF
# Test what the sed command would do
sed -E "s/(version:).*/\1 \"NEW_VERSION\"/" /tmp/test_sed.yamlRepository: alauda/pxc-docs
Length of output: 174
🏁 Script executed:
# Check the workflow file for any additional context about branch handling
cat -n .github/workflows/main.ymlRepository: alauda/pxc-docs
Length of output: 1497
Scope version updates to the primary site only.
The current sed command s/(version:).*/\1 \"$VERSION\"/ matches all version: keys in sites.yaml, not just the intended one. This will overwrite both the acp version (line 3) and the mysql-mgr version (line 6) with the same value. Additionally, the branch extraction pattern release-([0-9]+\.[0-9]+) is fragile and will fail silently for branch names outside the release-X.Y format (e.g., release/5.0, release-5.0-hotfix), and the VERSION variable is unescaped in the sed command, risking delimiter conflicts if extraction produces unexpected values.
Use a YAML-aware approach or anchor the sed pattern to target only the acp site section, with proper input validation and escaping.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@sites.yaml` around lines 4 - 6, The sed that sets version (s/(version:).*/\1
\"$VERSION\"/) is too broad and the branch regex release-([0-9]+\.[0-9]+) is
fragile; instead constrain updates to the acp site only (e.g., only modify the
version key in the block where "name: acp" appears) or use a YAML-aware tool
(yq) to set .sites[].version for the acp entry; strengthen branch extraction to
accept release[-/]<semver> variants (e.g.,
release[-/]([0-9]+(?:\.[0-9]+)*)(?:[-/].*)?) with validation and fallback, and
always escape the derived VERSION before passing to sed (or use an alternate sed
delimiter or printf %s to safely quote it) so delimiter/slash characters cannot
break the substitution.
Deploying alauda-mysql-pxc with
|
| Latest commit: |
35586a8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://58085280.alauda-mysql-pxc.pages.dev |
| Branch Preview URL: | https://fix-pxc-migration-docs.alauda-mysql-pxc.pages.dev |
1 participant
Summary by CodeRabbit
Documentation
Chores