Skip to content

Protection de Branche - Contract Check ​

Objectif ​

Empêcher l'introduction de régressions de contrat bridge (TV_API_REQUEST / TV_API_RESPONSE) dans main.

Le workflow GitHub Action Contract Check valide les fixtures de l'application contre le repo de contrat versionné.

La documentation complete du processus est disponible dans contract-validation.md.

Quand l'activer ​

Activer cette protection lorsque l'équipe est prête à bloquer les merges sur main en cas d'échec de validation contractuelle.

Configuration GitHub ​

  1. Aller dans Settings > Branches > Branch protection rules du repo SK_CAPACITOR_DISPLAY.
  2. Créer (ou éditer) la règle pour la branche main.
  3. Activer Require status checks to pass before merging.
  4. Ajouter le check Contract Check dans la liste des checks requis.
  5. (Recommandé) Activer aussi:
    • Require branches to be up to date before merging
    • Require pull request reviews before merging

Prérequis ​

  • Workflow prĂ©sent: .github/workflows/contract-check.yml
  • Secret configurĂ©: CONTRACT_REPO_TOKEN (read sur comminter/tvcast-display-hosts-api-contracts)
  • Runner disponible: self-hosted

Vérification ​

Après activation:

  1. Ouvrir une PR avec une fixture invalide dans contract/fixtures/.
  2. Vérifier que Contract Check échoue.
  3. Vérifier que GitHub bloque le merge vers main.

Référence ​

  • Processus complet: docs/technique/bridge/contract-validation.md
  • Roadmap: docs/technique/bridge/roadmap-hosts.md