docs: replace stale project README on GH-Actions with a pointer to v3.0 CI docs#5599
docs: replace stale project README on GH-Actions with a pointer to v3.0 CI docs#5599renecannao merged 2 commits intoGH-Actionsfrom
Conversation
…itecture doc The README.md on this branch was a stale copy of the ProxySQL project README. That was actively misleading -- anyone landing on the GH-Actions branch (e.g. by following a "Uses: .../ci-legacy-g1.yml@GH-Actions" link from a workflow run) saw the full project intro as if this were a normal development branch, when in fact only .github/workflows/ci-*.yml is meaningful here. Replace it with a focused README that: - States clearly that this is a CI-only branch and sends casual visitors back to v3.0 - Lists the files that actually matter (.github/workflows/ci-*.yml) - Points at doc/GH-Actions/README.md on v3.0 as the authoritative architecture reference - Provides a quick-reference cheatsheet for the three most common tasks: adding a new test group, modifying a reusable, deleting a reusable -- including the merge-order rule between this branch and v3.0 - Notes that everything else on this branch (source tree, docs, test directories) is vestigial and should not be edited here No changes to any workflow file.
|
Caution Review failedPull request was closed or merged during review 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)
📜 Recent review details🧰 Additional context used🪛 LanguageToolREADME.md[uncategorized] ~36-~36: The official name of this software platform is spelled with a capital “H”. (GITHUB) [uncategorized] ~80-~80: The official name of this software platform is spelled with a capital “H”. (GITHUB) [uncategorized] ~83-~83: The official name of this software platform is spelled with a capital “H”. (GITHUB) [uncategorized] ~106-~106: The official name of this software platform is spelled with a capital “H”. (GITHUB) 🔇 Additional comments (5)
📝 WalkthroughWalkthroughThe README.md was replaced with focused documentation for the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 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 |
![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
🧹 Nitpick comments (1)
README.md (1)
41-42: Tighten the Git wording for technical accuracy.“git never garbage-collected them” is misleading here; these files still exist because they are tracked on this branch, not because GC failed to remove them.
✏️ Suggested wording
-happen to still exist on this branch because git never garbage-collected -them. **Do not edit them here.** Any changes to source code, TAP tests, +happen to still exist because they remain tracked on this branch. +**Do not edit them here.** Any changes to source code, TAP tests,🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 41 - 42, The phrase "git never garbage-collected them" is technically inaccurate; replace that clause with wording that explains the files remain because they are tracked on the branch. Edit the sentence containing "git never garbage-collected them" (the README line that currently reads "happen to still exist on this branch because git never garbage-collected them") to something like "happen to still exist on this branch because they are still tracked on this branch" or "remain because they are tracked on this branch," keeping the surrounding emphasis and the instruction "**Do not edit them here.**" intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 16-32: The fenced code block that lists .github/workflows/ opens
with ``` but lacks a language tag, triggering markdownlint MD040; update the
block by adding a language identifier (e.g., "text") to the opening fence
(replace "```" with "```text") for the block that begins with
".github/workflows/" so the linter recognizes it as plain text.
---
Nitpick comments:
In `@README.md`:
- Around line 41-42: The phrase "git never garbage-collected them" is
technically inaccurate; replace that clause with wording that explains the files
remain because they are tracked on the branch. Edit the sentence containing "git
never garbage-collected them" (the README line that currently reads "happen to
still exist on this branch because git never garbage-collected them") to
something like "happen to still exist on this branch because they are still
tracked on this branch" or "remain because they are tracked on this branch,"
keeping the surrounding emphasis and the instruction "**Do not edit them
here.**" intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 33a09c8d-d57a-42b9-8b09-6aa9e4a12e81
📒 Files selected for processing (1)
README.md
📜 Review details
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~36-~36: The official name of this software platform is spelled with a capital “H”.
Context: ...v3.0 branch under the same path (e.g. v3.0:.github/workflows/CI-legacy-g1.yml). The calle...
(GITHUB)
[uncategorized] ~80-~80: The official name of this software platform is spelled with a capital “H”.
Context: .... 2. On GH-Actions (here): create .github/workflows/ci-<group>.yml. Cut it fr...
(GITHUB)
[uncategorized] ~83-~83: The official name of this software platform is spelled with a capital “H”.
Context: .... target. 3. On **v3.0**: create .github/workflows/CI-.yml` (the thin ...
(GITHUB)
[uncategorized] ~106-~106: The official name of this software platform is spelled with a capital “H”.
Context: ...ints at it. Grep for the filename in v3.0:.github/workflows/CI-*.yml. If any match, rewi...
(GITHUB)
🪛 markdownlint-cli2 (0.22.0)
README.md
[warning] 16-16: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request replaces the existing README.md with documentation specific to the GH-Actions branch. The new content clarifies that the branch is dedicated to hosting reusable GitHub Actions workflows rather than ProxySQL source code. It provides a directory map of the workflows, explains the relationship between the reusable workflows on this branch and the caller workflows on the v3.0 branch, and outlines procedures for common CI tasks such as adding or modifying test groups. I have no feedback to provide as there were no review comments.
…block with text Addresses review feedback on #5599: 1. The phrase "git never garbage-collected them" was technically inaccurate -- git does not GC tracked files. The files remain on this branch because they are still tracked and nobody has removed them. Reworded accordingly. 2. The fenced code block listing .github/workflows/ was untyped, triggering markdownlint MD040. Added the `text` language tag. Both flagged by CodeRabbit.
|
1 participant
Summary
Replaces the stale project `README.md` on the `GH-Actions` branch (which was an old copy of the ProxySQL project intro) with a focused README that:
Why
Previously, anyone landing on the `GH-Actions` branch — e.g. by following a `Uses: .../ci-legacy-g1.yml@GH-Actions` link from a workflow run log — saw the full ProxySQL project README as if this were a normal development branch. That's actively misleading: only `.github/workflows/ci-*.yml` is meaningful on this branch. The rest of the tree is vestigial leftover that nobody should be editing here.
The replacement README says so explicitly in the first three lines, and gives readers a clear path to the real docs on `v3.0`.
Depends on
#5598 — that's the v3.0 PR that creates `doc/GH-Actions/README.md`. This PR links to that file, so merging this before #5598 would leave the link dangling for a short window. Low stakes (the link is at the top of the file and GitHub 404 pages are self-explanatory) but ideally merge #5598 first.
Test plan
Out of scope
Summary by CodeRabbit