Skip to content

docs: add advanced configuration section for env vars and config file usage#234

Merged
shenxianpeng merged 2 commits into
mainfrom
docs/env-vars-config-usage
Jul 6, 2026
Merged

docs: add advanced configuration section for env vars and config file usage#234
shenxianpeng merged 2 commits into
mainfrom
docs/env-vars-config-usage

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 6, 2026

Copy link
Copy Markdown
Member

Summary

Instead of adding a separate action input for every commit-check CLI option, document that users can use environment variables or config files for advanced configuration.

Changes

  • Add Advanced Configuration heading to the Table of Contents
  • New ## Advanced Configuration section after Optional Inputs with two sub-sections:
    • Via Environment Variables — set CCHK_* variables in the workflow step's env:
    • Via Configuration File — existing commit-check.toml / cchk.toml approach
  • Remove the tip block that was previously crammed at the end of Optional Inputs

Motivation

The newly added --ai-attribution forbid feature in commit-check v2.11.0 doesn't need a dedicated action input — users can enable it via env::

- uses: commit-check/commit-check-action@v2
  env:
    CCHK_AI_ATTRIBUTION: forbid

This pattern applies to all advanced commit-check options, keeping the action's surface area small while giving users full flexibility.

Preview: https://github.com/commit-check/commit-check-action/blob/docs/env-vars-config-usage/README.md

@shenxianpeng shenxianpeng requested a review from a team as a code owner July 6, 2026 15:19
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Commit-Check ❌

Commit rejected by Commit-Check.                                  
                                                                  
  (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)  
   / ._. \      / ._. \      / ._. \      / ._. \      / ._. \   
 __\( C )/__  __\( H )/__  __\( E )/__  __\( C )/__  __\( K )/__ 
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
   || E ||      || R ||      || R ||      || O ||      || R ||   
 _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._ 
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
 `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´ 
                                                                  
Commit rejected.                                                  
                                                                  
Type branch check failed ==> docs/env-vars-config-usage 
The branch should follow Conventional Branch. See https://conventionalbranch.org
Suggest: Use <type>/<description> with allowed types or add branch name to allow_branch_names in config, or use ignore_authors in config branch section to bypass

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fad8d773-8230-43a2-9814-a58b75b641fa

📥 Commits

Reviewing files that changed from the base of the PR and between aa0dca3 and a977cb9.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/env-vars-config-usage

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@shenxianpeng shenxianpeng changed the title docs: add env vars usage for advanced configuration options docs: add advanced configuration section for env vars and config file usage Jul 6, 2026
@shenxianpeng shenxianpeng merged commit a9ee0cf into main Jul 6, 2026
5 of 12 checks passed
@shenxianpeng shenxianpeng deleted the docs/env-vars-config-usage branch July 6, 2026 15:23
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant