PR comments

Carrick can post a findings comment on your pull requests: type mismatches between services, changed or missing routes, wrong HTTP verbs, and dependency-version conflicts. The comment is posted by the Carrick GitHub App and updated in place on each push, so a PR never collects a stack of duplicates.

Turn it on

PR comments are off by default and set per project.

1. Install the GitHub App on the repos you want, from the project’s Repos page.
2. Open the project in the dashboard at app.carrick.tools.
3. Under PR comments, click Enable.

That is the whole setup. There is no workflow step to add and no token to manage: the App authenticates itself and posts the comment for you.

What gets posted

On each pull request, Carrick compares the branch against the project’s index and comments when it finds contract drift:

• A consumer calls an endpoint the producer no longer exposes, or with a mismatched method or path.
• A request or response type no longer lines up between a producer and its consumers.
• A dependency is pinned to a version that conflicts with the rest of the project.

When there is nothing to flag, Carrick does not comment. The single comment is rewritten in place as the PR evolves, so the latest state is always there rather than buried under older runs.

Turn it off

Toggle PR comments off on the project page at any time. Existing comments stay; no new ones are posted.

Related

• Quickstart covers installing the App and connecting repos.
• carrick.json classifies the outbound calls that contract checking runs against.