🧰 Captive Renovate Configuration

(@captive-studio/renovate-config)

Configuration partagée pour Renovate, optimisée pour les projets Captive. Elle vise à automatiser les mises à jour de dépendances en toute sécurité, sans submerger les équipes.

---

🚀 Démarrage rapide

1. Installer Renovate

• Installer pour GitHub
• Installer pour GitLab

Une fois installé :

1. Rendez-vous sur le tableau de bord Renovate
2. Ajoutez votre projet
3. Acceptez la première Pull Request de configuration proposée par Renovate Bot

---

✨ Fonctionnalités principales

• ✅ Automerge sécurisé

  • Activé uniquement lorsque les dépendances sont validées par la CI
  • Compatible avec les projets respectant le semantic versioning

• 🚄 Productivité sans surcharge

  • Limite le nombre de PR simultanées
  • Priorise la stabilité et la lisibilité du flux de mises à jour

• 🧩 Technologies principales supportées

  • Ruby
  • Node.js
  • Docker

• 🗓️ Planification intelligente

  • Exécution en dehors des heures ouvrées (nuits et week-ends)

---

⚙️ Utilisation

Prérequis

• Renovate doit être installé et avoir les autorisations nécessaires sur le dépôt.

---

🧩 PHASE 1 — Configuration initiale

⏱️ Durée estimée : 5 minutes à 1 jour selon le planning Renovate

🎯 Objectif : Configurer Renovate pour :

• Créer automatiquement des PR de mise à jour
• Limiter leur volume selon la capacité de l’équipe
• Planifier leur exécution hors des heures de travail

1. Étendre la configuration partagée

Pour une application (non réutilisée ailleurs) :

// renovate.json
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "github>captive-studio/renovate-config:application"
  ]
}

Pour une bibliothèque (réutilisée dans d’autres projets) :

// renovate.json
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "github>captive-studio/renovate-config:library"
  ]
}

2. Configurer les propriétaires (CODEOWNERS)

⚠️ Sans propriétaires définis, les PR de maintenance risquent d’être ignorées.

Utilisez des références personnelles (@prenom.nom) ou d’équipe (@NomEquipe). 👉 Exemple : CODEOWNERS

3. Limiter la concurrence des PR (optionnel)

Utile pour les anciens projets peu maintenus.

{
  "extends": [
    "github>captive-studio/renovate-config:...",
-   // configuration standard
+   "github>captive-studio/renovate-config:rate-limited"
  ]
}

Cette variante limite le nombre de PR simultanées à 6 pour éviter l’encombrement.

4. Vérifier la création du ticket “Dependency Dashboard”

Ce ticket est automatiquement généré sur GitHub/GitLab après quelques minutes.

5. 🎉 Laissez Renovate travailler !

Les premières PR apparaîtront selon la planification définie.

---

🤖 PHASE 2 — Automatisation et réduction du bruit

⏱️ Durée estimée : 1 jour à 1 semaine

🎯 Objectif :

• Automatiser un maximum de PR (automerge: true)
• Éviter les PR dormantes de plus de 24h
• Prioriser la sécurité et la non-régression

Étapes recommandées :

1. Ajouter des tests (unitaires, end-to-end) permettant de garantir la fiabilité des merges automatiques
2. Activer automerge dans le projet ou dans la configuration partagée
3. Rebaser une PR via Renovate et vérifier que le merge automatique est bien activé

---

🔁 PHASE 3 — Maintenance continue

🎯 Objectif : Maintenir le nombre de dépendances obsolètes aussi proche de zéro que possible.

Conditions préalables :

• Le stock de dépendances obsolètes est déjà faible
• L’équipe peut absorber toutes les PR générées

Exemple :

{
  "extends": [
    "github>captive-studio/renovate-config:...",
-   "github>captive-studio/renovate-config:rate-limited"
+   // suppression de la limitation
  ]
}

📘 Pour aller plus loin : Documentation complète de Renovate

---

🧰 Ajouter une dépendance en automerge (CLI)

Pour autoriser/automerger une gem Ruby ou un package npm sans éditer les presets à la main, utilise la CLI interactive :

bin/autorise-dependance

Elle te guide pas à pas (type de dépendance → nom → niveau actionnable) puis écrit au bon endroit dans preset/automergeRecommendedGems.json ou preset/automergeRecommendedNPM.json, valide et formate automatiquement. Seuls les niveaux encore nécessaires sont proposés (ou appliqués automatiquement s'il n'y en a qu'un).

Bon à savoir :

• Gems Ruby : les patch et minor sont déjà automergés par défaut — seuls les major demandent une action (toutes versions, ou une montée ciblée 7.x → 8.x).
• npm : les patch sont déjà automergés globalement ; ajoute un package pour les minor (liste de confiance) ou les major (toutes versions ou montée ciblée).

Prérequis : jq (brew install jq).

---

🤖 Fusionner les PR Renovate en attente (CLI)

Pour la routine hebdomadaire de maintenance : fusionne automatiquement les PR Renovate déjà prêtes (automerge activé, checks verts) des repos listés dans le ticket Jira de la semaine, et relance les checks CI rouges.

bin/automerge-renovate automerge

👉 Documentation complète (installation, variables d'environnement, architecture, pièges connus) : automerge-renovate/README.md.

---

📚 Documentation complémentaire

• Documentation officielle Renovate
• Configuration JSON Schema
• Tableau de bord Renovate

---

🧩 Bonnes pratiques Captive

• ✅ Toujours définir un responsable via CODEOWNERS
• ✅ Garder le tableau de bord “Dependency Dashboard” à jour
• ✅ Ne pas ignorer les PR obsolètes
• ✅ Supprimer les limitations une fois la stabilité atteinte

---

🪪 Licence

MIT © Captive Studio

---