diff --git a/docs/blog/posts/ai-commit-attribution-policy.md b/docs/blog/posts/ai-commit-attribution-policy.md index 4ba1a58..80d66b0 100644 --- a/docs/blog/posts/ai-commit-attribution-policy.md +++ b/docs/blog/posts/ai-commit-attribution-policy.md @@ -141,7 +141,15 @@ branch's ruleset or branch protection, and a commit that fails it cannot be merged. [Where to run it](../../guides/integrations.md) walks through each setup. -To try the disclosure policy without writing a config file: +On GitHub, the quickest way to get there is the +[Commit Check App](https://github.com/apps/commit-check): install it on a +repository or an organization, commit a `cchk.toml` that sets +`ai_attribution`, and every push and pull request gets a **Commit Check** +result, with no workflow file to maintain. The App is free for public +repositories and personal accounts. + +To try the disclosure policy on your machine first, without writing a config +file: ```bash pip install commit-check diff --git a/docs/example.md b/docs/example.md index ecfb0e8..cd1eafe 100644 --- a/docs/example.md +++ b/docs/example.md @@ -239,8 +239,9 @@ To override the detection: Whatever the destination, the commit text in a failure is printed inert. Control characters other than newline and tab appear as `\xNN`, and a line -that starts with `::` is printed as `\::`, so a commit message cannot move the -terminal's cursor or send a GitHub Actions runner a workflow command. +that starts with `::` is printed as `\::`, so a commit message cannot send +control sequences to the terminal, or workflow commands to a GitHub Actions +runner. `--format json` is not affected; JSON escapes those characters already. ### Checking a range of commits diff --git a/docs/getting-started.md b/docs/getting-started.md index d21b8e2..8518dae 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -5,6 +5,13 @@ commit message on your machine, and wired into the two places it belongs. It takes about five minutes and needs nothing but a Git repository. +!!! tip "On GitHub and want nothing to install?" + + [Install the GitHub App](https://github.com/apps/commit-check): every push + and pull request gets a **Commit Check** result, with no workflow file. The + [App guide](guides/github-app.md) covers what it checks. This page sets up + the CLI and the hook, which work with any Git host. + ## 1. Install === "pip" diff --git a/docs/index.md b/docs/index.md index 11a6810..54d9e7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,7 +34,7 @@ description: Commit policy as code for teams and AI agents. Messages, branches,

Catch bad commits before they merge.

Commit policy as code for teams and AI agents. Commit Check validates commit messages, branch names, authors and sign-offs against one cchk.toml — in your commit hook, in CI, on every pull request and inside your AI agent. When the fix is obvious, it hands you the line.

-Add to GitHub Actions +Install the GitHub App
pip install commit-check
@@ -102,23 +102,23 @@ conventional_branch = true - id: check-message Hook guide → -
  • - -Most teams start here -Enforced in CI -GitHub Action -A required check no one can skip, with a PR comment and a job summary. -commit-check-action@v2 -Action guide → -
    • -
  • +
  • +Fastest to set up Zero YAML GitHub App Install once. Every push and pull request gets a check run, no CI minutes. apps/commit-check App guide →
    • +
  • + +Enforced in CI +GitHub Action +A required check no one can skip, with a PR comment and a job summary. +commit-check-action@v2 +Action guide → +
  • For AI agents @@ -442,7 +442,7 @@ conventional_branch = true

    Nothing is blocked while you try it: without a config file the App reports its findings but leaves the check run neutral. GitHub's own commit-metadata rules sit behind its Enterprise plan — the arithmetic, and the caveats →