Skip to content

CodeCharter GitHub App

Installiere die CodeCharter GitHub App, damit CodeCharter gebrandete Checks und PR-Kommentare postet — ohne Token auf dem Runner, ohne Zusatzrechte.

Die CodeCharter GitHub App ist der empfohlene Weg, CodeCharter-Ergebnisse auf GitHub zu veröffentlichen. Ist sie installiert, postet die Action über das Portal einen gebrandeten CodeCharter-Check-Run und einen PR-Zusammenfassungs-Kommentar unter der Identität der App.

Vorteile gegenüber der reinen Action:

  • Ein gebrandeter CodeCharter-Check (mit stabilem Check-Namen für die Branch-Protection) statt eines github-actions[bot]-Kommentars.
  • Kein GitHub-Token auf dem Runner und kein pull-requests: write im Workflow — die App bringt die Berechtigungen mit.
  • Dasselbe Ergebnis bei Fork-PR-Builds, wo Workflow-Tokens eingeschränkt sind.

Die App ersetzt die Action nicht

CodeCharter läuft weiterhin in deinem Workflow — es wird nichts von deinem Code an unsere Server übertragen; die Analyse passiert wie bisher auf deinem Runner. Die App ändert nur, wie die Ergebnisse veröffentlicht werden: statt über das Workflow-Token übergibt die Action das Ergebnis dem Portal, das es als CodeCharter postet. Ist die App nicht installiert, fällt die Action automatisch auf den Workflow-Token-Kommentar zurück, es bricht also nichts. Den Workflow-Aufbau beschreibt GitHub Actions.

Installation

  1. Öffne github.com/apps/codecharter und installiere sie auf deiner Organisation (oder ausgewählten Repositories).
  2. Du wirst zurück ins Portal geleitet, das die Installation automatisch mit deinem CodeCharter-Konto verknüpft. Den Status siehst du jederzeit unter Dashboard → GitHub.
  3. Nutze die Action weiter wie gewohnt. Beim nächsten Pull Request erscheinen der CodeCharter-Check und -Kommentar — und du kannst pull-requests: write aus dem Workflow entfernen.

Branch-Protection

Trage den CodeCharter-Check als Pflicht in deine Branch-Protection-Regel ein (Settings → Branches → Require status checks). Der Check-Name ist stabil, das Gate funktioniert also auch nach Workflow-Umbenennungen weiter.

Entfernen

Deinstalliere die App jederzeit in den Settings deiner GitHub-Organisation. CodeCharter fällt dann automatisch auf den Workflow-Token-Kommentar zurück (der wieder pull-requests: write braucht).