docs: add [skip ci] documentation to CONTRIBUTING.md#8876
Conversation
Signed-off-by: R. Garcia-Dias <rafaelagd@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds a new "Skipping CI" section to CONTRIBUTING.md (92 lines) that documents how to skip GitHub Actions workflows using commit-message keywords like Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 363-367: The fenced code block shown in CONTRIBUTING.md triggers
MD040 because it lacks a language tag; update the block to include a language
identifier (e.g., change the opening fence to ```text or ```md) so the snippet
is explicitly marked and the linter warning is resolved—ensure the same fence
style is used for the closing fence and leave the content unchanged.
- Line 335: Add a Table of Contents entry linking to the newly added "##
Skipping CI" section: update the TOC block at the top (lines 1-16) to include a
markdown link like "- [Skipping CI](`#skipping-ci`)" so the new heading is
discoverable; ensure the anchor matches the heading slug format used throughout
the document and maintain TOC ordering/formatting consistent with existing
entries.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 4cb868d1-cda8-4c58-8c75-8a9c29af1b8c
📒 Files selected for processing (1)
CONTRIBUTING.md
| 1. Reviewer and contributor may have discussions back and forth until all comments addressed. | ||
| 1. Wait for the pull request to be merged. | ||
|
|
||
| ## Skipping CI |
There was a problem hiding this comment.
Add the new section to the Table of Contents.
## Skipping CI was added, but the TOC (Lines 1-16) was not updated with a link entry.
As per coding guidelines, "Remember that documentation must be updated with the latest information."
🤖 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 `@CONTRIBUTING.md` at line 335, Add a Table of Contents entry linking to the
newly added "## Skipping CI" section: update the TOC block at the top (lines
1-16) to include a markdown link like "- [Skipping CI](`#skipping-ci`)" so the new
heading is discoverable; ensure the anchor matches the heading slug format used
throughout the document and maintain TOC ordering/formatting consistent with
existing entries.
Description
Adds a new "Skipping CI" section to CONTRIBUTING.md documenting the native GitHub Actions commit-message mechanism for skipping CI pipelines.
The section covers:
[skip ci],[ci skip],[no ci],[skip actions],[actions skip])skip-checks: truetrailer alternative[skip ci]No workflow YAML changes needed — GitHub Actions handles this natively.
Types of changes
./runtests.sh -f -u --net --coverage../runtests.sh --quick --unittests --disttests.make htmlcommand in thedocs/folder.