Skip to content

docs: document commit-check-ci and name GitLab and Bitbucket on the homepage - #95

Merged
shenxianpeng merged 2 commits into
mainfrom
docs/commit-check-ci-and-platforms
Nov 19, 2026
Merged

shenxianpeng merged 2 commits into
mainfrom
docs/commit-check-ci-and-platforms

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Before: the GitLab CI and Bitbucket Pipelines guide gave a hand-written job of about 20 lines (fetch the target branch, loop over the commits, pipe the title in), and the homepage did not say that Commit Check runs anywhere but GitHub and "any Git host". The pre-commit pins still named v2.22.0.

After: the guide uses commit-check-ci, which v2.23.0 added, and the homepage names GitHub, GitLab and Bitbucket. The site is in step with v2.23.0.

The guide

# GitLab CI
  script:
    - pip install commit-check
    - commit-check-ci
# Bitbucket Pipelines
          script:
            - pip install commit-check
            - commit-check-ci
  • The title and description checks are commit-check-ci --pr-title --pr-body-ai-attribution on both. On Bitbucket the token goes in a secured variable named BITBUCKET_ACCESS_TOKEN; the curl and python -c lines are gone.
  • A new Options table lists the seven checks and their defaults.
  • The sample output is a transcript of this job on GitLab CE 19.5 with the wheel published on PyPI.
  • The Bitbucket note no longer says the default clone depth is 50 commits: a pull request step's default clone is now cut to fit the request. The example keeps clone: depth: full.
  • Azure Pipelines keeps its hand-written job, since commit-check-ci reads only GitLab's and Bitbucket's variables.
  • The GitLab CI/CD component is not mentioned: it is not published yet.

The homepage (copy, please review)

Where Before After
Hero facts CLI and hook work with any Git host GitHub, GitLab, Bitbucket and any Git host
Command line card Any forge, any CI GitLab, Bitbucket, any CI
Under the five cards (nothing) On GitLab CI or Bitbucket Pipelines? One job checks every merge request →
FAQ "Does it only work on GitHub?" The CLI and the pre-commit hook run anywhere Git does… No. On GitLab CI and Bitbucket Pipelines one command, commit-check-ci, checks every merge or pull request…
Page description …to every pull request. …to every pull request, on GitHub, GitLab and Bitbucket.

"Where to run it" gets a row and a short section for GitLab CI and Bitbucket Pipelines.

In step with v2.23.0

  • Six rev: pins move from v2.22.0 to v2.23.0.
  • The changelog has the v2.23.0 entry (2026-11-19) and a Highlights row.
  • Two samples of a failed description check now start ✖ Rejected by Commit Check, as 2.23.0 prints it.

How it was checked

  • python -m pytest tests/ -q with commit-check 2.23.0 installed: 18 passed.
  • mkdocs build --strict: clean.
  • The GitLab job above and its title-and-description form were run as written on GitLab CE 19.5 with a real runner.
  • The Bitbucket step was run in python:3.13 on a checkout made with the commands Bitbucket's own pull request pipelines run. It has not run on Bitbucket itself, and the API read with a real access token is untested.

The GitLab CI and Bitbucket Pipelines jobs become two lines: install the
package and run commit-check-ci, which v2.23.0 added. Azure Pipelines keeps
the hand-written job.

Bring the rest of the site in step with v2.23.0: the pre-commit pins, the
changelog entry, and the two samples of a failed description check, whose
heading that release changed.
Say where Commit Check runs in the hero facts, on the command line card,
under the cards with a link to the GitLab and Bitbucket guide, in the FAQ
and in the page description.
@netlify

netlify Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit f9872b8
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6afeea96ce00e77d7393b2e5
😎 Deploy Preview https://deploy-preview-95--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Nov 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 29 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 43b46f8b-6ca8-4200-b8b7-fe0702d886eb
Commits

Reviewing files that changed from the base of the PR and between 0325250 and f9872b8.

Files selected for processing: 11

  • docs/changelog.md
  • docs/compare/tools.md
  • docs/configuration.md
  • docs/example.md
  • docs/guides/integrations.md
  • docs/guides/other-ci.md
  • docs/guides/policies.md
  • docs/guides/pre-commit.md
  • docs/index.md
  • docs/rules.md
  • docs/stylesheets/landing.css
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Nov 19, 2026 — with Claude
@shenxianpeng
shenxianpeng merged commit 8f11eb4 into main Nov 19, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the docs/commit-check-ci-and-platforms branch November 19, 2026 13:08
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