Appearance
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 ​
- Aller dans
Settings > Branches > Branch protection rulesdu repoSK_CAPACITOR_DISPLAY. - Créer (ou éditer) la règle pour la branche
main. - Activer Require status checks to pass before merging.
- Ajouter le check
Contract Checkdans la liste des checks requis. - (Recommandé) Activer aussi:
Require branches to be up to date before mergingRequire pull request reviews before merging
Prérequis ​
- Workflow présent:
.github/workflows/contract-check.yml - Secret configuré:
CONTRACT_REPO_TOKEN(read surcomminter/tvcast-display-hosts-api-contracts) - Runner disponible:
self-hosted
Vérification ​
Après activation:
- Ouvrir une PR avec une fixture invalide dans
contract/fixtures/. - Vérifier que
Contract Checkéchoue. - 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