ci: enforce consistent markdown formatting with rumdl#511
ci: enforce consistent markdown formatting with rumdl#511
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds rumdl markdown linting: a new GitHub Actions job Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Local as Local Repo
participant PreCommit as Pre-commit
participant CI as GitHub Actions
participant Rumdl as rvben/rumdl
Dev->>Local: edit files & run git commit
Local->>PreCommit: run `rumdl-fmt` hook
PreCommit->>Local: pass or report issues
Dev->>CI: push / open PR
CI->>Rumdl: run `rumdl-check` job (`rvben/rumdl@v0.1.68`)
Rumdl->>CI: lint results (pass/fail)
CI->>Dev: report status
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
48-54:⚠️ Potential issue | 🟠 MajorDocument rumdl/pre-commit in contributor validation steps.
The PR adds a required markdown check in CI plus a pre-commit hook, but these sections still omit the dependency and a local command to run it. Please add
pre-commit(or explicitrumdl) under dependencies and include a local validation step such aspre-commit run --all-files.📝 Suggested doc update
To run the same checks as CI, make sure these tools are available locally: - `bash`, `zsh`, and `fish` - `shellcheck` - `curl` - `bashunit` as `lib/bashunit` +- `pre-commit` (includes `rumdl-fmt` from `.pre-commit-config.yaml`) @@ shellcheck forgit.plugin.sh bin/git-forgit +pre-commit run --all-files lib/bashunit . bash forgit.plugin.sh zsh forgit.plugin.zsh fish conf.d/forgit.plugin.fishAs per coding guidelines:
Update docs (README.md and CONTRIBUTING.md) for user-visible changes.Also applies to: 66-72
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 48 - 54, Update CONTRIBUTING.md (and README.md where applicable) to list the pre-commit dependency (explicitly mention rumdl/pre-commit or pre-commit) in the local prerequisites and add a local validation command example such as "pre-commit run --all-files" (or the equivalent rumdl command) to the section that currently lists shellcheck/curl/bashunit so contributors can run the same markdown/pre-commit checks locally.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.pre-commit-config.yaml:
- Around line 23-24: Update the pinned revision for the rumdl pre-commit hook in
.pre-commit-config.yaml: change the rev value currently set to v0.1.62 to match
CI by using v0.1.68 so local pre-commit runs use the same rumdl version as CI
(update the rev field under the repo entry for
https://github.com/rvben/rumdl-pre-commit).
In @.rumdl.toml:
- Line 23: The MD003 failure is caused by forcing setext headings via the style
= "setext" setting; change that setting to allow mixed heading levels by
replacing style = "setext" with style = "consistent" (or remove the explicit
style entry) in .rumdl.toml so the linter won't force only setext headings and
will accept the README's ATX H3/H4 headings.
---
Outside diff comments:
In `@CONTRIBUTING.md`:
- Around line 48-54: Update CONTRIBUTING.md (and README.md where applicable) to
list the pre-commit dependency (explicitly mention rumdl/pre-commit or
pre-commit) in the local prerequisites and add a local validation command
example such as "pre-commit run --all-files" (or the equivalent rumdl command)
to the section that currently lists shellcheck/curl/bashunit so contributors can
run the same markdown/pre-commit checks locally.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 98a0b302-08f4-4f6d-8119-b923de7c8db4
📒 Files selected for processing (6)
.github/workflows/ci.yaml.pre-commit-config.yaml.rumdl.tomlAGENTS.mdCONTRIBUTING.mdREADME.md
carlfriedrich
left a comment
carlfriedrich
left a comment
There was a problem hiding this comment.
Great addition, thanks @sandr01d
sandr01d
force-pushed
the
rumdl
branch
2 times, most recently
from
54a7749 to
934d41c
Compare
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 `@CONTRIBUTING.md`:
- Line 72: The CONTRIBUTING.md file references running "rumdl check ." but the
Development Dependencies section doesn't list rumdl; update that section to
include rumdl as a required development dependency (mentioning a recommended
install command or version), e.g., add an entry named "rumdl" to the Development
Dependencies list and optionally a short install note so contributors can run
the documented validation step end-to-end; ensure the addition appears alongside
the existing dev deps referenced in the Development Dependencies section.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1b11019c-f6ab-4824-a463-31764267ad08
📒 Files selected for processing (6)
.github/workflows/ci.yaml.pre-commit-config.yaml.rumdl.tomlAGENTS.mdCONTRIBUTING.mdREADME.md
✅ Files skipped from review due to trivial changes (3)
- .pre-commit-config.yaml
- AGENTS.md
- .rumdl.toml
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/workflows/ci.yaml
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 `@CONTRIBUTING.md`:
- Line 54: Add a small installation subsection for rumdl in CONTRIBUTING.md
after the bashunit install section that mirrors the existing pattern (include
the tool name "rumdl", the specific version v0.1.68 used by pre-commit/CI, and
an install command or link), and reference that it can also be installed
automatically via the pre-commit hook; update the README text near the
validation commands (the validation command mention around "rumdl") so readers
can run/install rumdl end-to-end.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 58a20cf6-6fe8-470a-9b44-daf1d39baa37
📒 Files selected for processing (6)
.github/workflows/ci.yaml.pre-commit-config.yaml.rumdl.tomlAGENTS.mdCONTRIBUTING.mdREADME.md
✅ Files skipped from review due to trivial changes (3)
- .rumdl.toml
- .pre-commit-config.yaml
- AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/workflows/ci.yaml
2 participants
Check list
Description
Enforce a consisten markdown style using rumdl. This includes:
As a side node, I'm working on something similar for our shell scripts. Just have to wait for the next version of
shfmtto bring some fixes we need.Type of change
Test environment
Summary by CodeRabbit
Chores
Documentation