CodeCharter GitHub App

The CodeCharter GitHub App is the recommended way to publish CodeCharter results on GitHub. With it installed, the action posts a branded CodeCharter check run and a pull request summary comment through the portal, under the app's own identity.

What you get over the bare action:

• A branded CodeCharter check (and a stable check name you can require in branch protection) instead of a github-actions[bot] comment.
• No GitHub token on the runner and no pull-requests: write in your workflow — the app carries the permissions.
• The same result on forked-PR builds, where workflow tokens are restricted.

The app does not replace the action

CodeCharter still runs in your workflow — the action checks out nothing of yours to our servers; the analysis happens on your runner as before. The app only changes how the results are published: instead of the workflow token, the action hands the result to the portal, which posts it as CodeCharter. If the app is not installed, the action falls back to the workflow-token comment, so nothing breaks. See GitHub Actions for the workflow setup.

Install

1. Open github.com/apps/codecharter and install it on your organization (or selected repositories).
2. You are redirected back to the portal, which links the installation to your CodeCharter account automatically. You can review the connection any time under Dashboard → GitHub.
3. Keep using the action as usual. On the next pull request you'll see the CodeCharter check and comment — and you can remove pull-requests: write from the workflow.

Branch protection

Require the CodeCharter check in your branch protection rule (Settings → Branches → Require status checks). The check name is stable, so the gate keeps working across workflow renames.

Removing it

Uninstall the app from your GitHub organization's settings at any time. CodeCharter then falls back to the workflow-token comment automatically (which again needs pull-requests: write).