Auf dieser Seite

Abhängigkeiten in vielen Repositories automatisch aktuell halten

Software baut auf Bibliotheken und Frameworks auf, und jede davon ist eine bewusste Abhängigkeit. Diese Abhängigkeiten bleiben nicht stehen: Sie entwickeln sich weiter, Bugs werden gefixt, und mit jeder neuen Version kommt Arbeit auf die eigene Software zu. Die meisten Updates verlangen keine strukturelle Anpassung, aber jedes will auf Kompatibilität getestet werden, und dafür braucht es Zeit. Wer diese Arbeit immer wieder aufschiebt, hat irgendwann aus vielen kleinen Updates ein großes gemacht, das mehrere Stunden, Tage oder Wochen kostet, und für das nie der richtige Zeitpunkt kommt. Bis schließlich eine Sicherheitslücke den Zeitpunkt bestimmt.

Klein bleibt ein Update nur, wenn es von selbst kommt und an einer Stelle geregelt ist. Sobald ein System aus mehr als einer Handvoll Repositories besteht, setze ich deshalb automatische Updates auf, mit einer gemeinsamen Konfiguration für alle. Dieser Artikel beschreibt, wie dies möglich ist, welche Regeln verhindern, dass das Team in Update-Pull-Requests untergeht, und welche Fallstricke bleiben. Die Beispiele stammen aus einem erfundenen Verbund von Fahrradwerkstätten, der Terminbuchung, Ersatzteillager und Rechnungen in getrennten Repositories pflegt.

Wie es funktioniert

Ein Werkzeug dafür heißt Renovate. Es unterstützt über 90 Paketmanager und Build-Werkzeuge plattformübergreifend auf GitHub, GitLab, Bitbucket, Azure DevOps und Gitea. Es liest die Build-Dateien eines Repositories, etwa pom.xml, build.gradle.kts, package.json oder Dockerfile, und prüft regelmäßig, ob es neuere Versionen gibt. Für jedes Update öffnet es einen Pull Request mit Changelog-Auszug. Die Pipeline läuft, die Tests zeigen, ob das Update etwas bricht, und ein Mensch entscheidet.

Der Aufwand verschiebt sich damit. Niemand muss mehr nach Updates suchen. Es bleibt nur die Frage, ob ein fertiger Pull Request übernommen wird.

Renovate läuft entweder als gehostete App bei GitHub oder selbst betrieben als Job in der eigenen Pipeline, zum Beispiel bei GitLab (Wege zum Selbstbetrieb).

Eine zentrale Konfiguration

Entscheidend ist, dass die Regeln nicht in jedem Repository stehen, sondern an einer Stelle. Renovate nennt das ein Preset. Es liegt in einem eigenen Repository, und jedes andere Repository enthält nur einen Verweis darauf:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["local>werkstattnetz/renovate-config"]
}

local> bedeutet: ein Repository auf derselben Plattform. Ohne Dateiangabe liest Renovate dort die Datei default.json. Sie legt fest, was für alle gilt:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "config:recommended",
    "helpers:pinGitHubActionDigests",
    "docker:pinDigests"
  ],
  "timezone": "Europe/Berlin",
  "schedule": ["* 0-5 * * 1"],
  "prConcurrentLimit": 5,
  "minimumReleaseAge": "3 days",
  "lockFileMaintenance": { "enabled": true },
  "packageRules": [
    {
      "matchUpdateTypes": ["minor", "patch"],
      "groupName": "kleine Updates"
    },
    {
      "matchPackageNames": ["de.werkstattnetz:**", "de.werkstattnetz.*:**"],
      "groupName": "eigene Bibliotheken"
    },
    {
      "description": "Testdatenbank nutzt dieselbe Hauptversion wie die Produktivdatenbank, Anhebung nur zusammen mit ihr",
      "matchDatasources": ["docker"],
      "matchPackageNames": ["postgres"],
      "matchUpdateTypes": ["major"],
      "enabled": false
    }
  ]
}

Ändert sich eine Regel, ändere ich sie einmal. Beim nächsten Lauf gilt sie überall. Das gilt in beide Richtungen: Auch eine falsche oder böswillige Änderung wirkt sofort in jedem Repository. Eine ungültige Option im Preset legt beim nächsten Lauf alle Repositories gleichzeitig lahm. Das Preset-Repository bekommt deshalb eine eigene Pipeline, die jede Änderung vor dem Zusammenführen prüft:

npx --yes --package renovate -- renovate-config-validator default.json

Dazu braucht es mindestens denselben Schutz wie der Code selbst: Änderungen nur per Review, ein geschützter Hauptzweig, wenige Personen mit Schreibrecht. Wer Renovate selbst betreibt, gibt dem Zugang nur die Repositories, die er wirklich bearbeiten soll. Wer Änderungen schrittweise ausrollen will, verweist auf einen Tag statt auf den Hauptzweig, etwa local>werkstattnetz/renovate-config#v2. Die Repositories ziehen dann erst nach, wenn der Verweis angehoben wird.

Die Einführung bleibt klein: Pro Repository ist es eine Datei mit wenigen Zeilen. Renovate schlägt sie beim ersten Lauf selbst in einem Onboarding-Pull-Request vor. Die Vorlage dafür lässt sich in der Konfiguration des Renovate-Laufs auf das gemeinsame Preset setzen.

Ein Repository darf Regeln ergänzen. Es schreibt sie unter die extends-Zeile in seine eigene Datei. Das ist gewollt, sollte aber selten sein. Was zwei Repositories brauchen, gehört meist ins Preset.

Einige Einstellungen sind unscheinbar und wirken trotzdem viel:

Regeln gegen die Flut

Renovate drosselt schon von sich aus, wie viele Pull Requests es gleichzeitig öffnet. Ohne eigene Regeln kommt trotzdem jede Woche ein Strom einzelner Updates, je Repository und je Paket. Nach ein paar Wochen klickt niemand mehr hinein. Diese Regeln haben sich bewährt:

Die Gruppe für kleine Updates hat einen Preis. Bricht eines von zwanzig Updates den Build, blockiert es die anderen neunzehn. Dann hilft nicht, die Gruppe aufzulösen, sondern das eine Update herauszunehmen: mit einer eigenen Regel, die es vorübergehend zurückstellt und den Grund nennt. Sobald es behoben ist, fliegt die Regel wieder raus.

Pakete, die nur gemeinsam funktionieren, gehören in eine eigene Gruppe. Sonst kommt ein Teil eine Woche früher als der Rest, und der Build bricht an einer Stelle, die mit dem Update scheinbar nichts zu tun hat. Für bekannte Frameworks bringt config:recommended solche Gruppen schon mit. Für die eigenen Bibliotheken fehlt sie immer, deshalb steht sie oben im Preset.

Bei gemischten Sprachen und Build-Werkzeugen lohnt ohnehin ein Blick darauf, was Renovate wirklich erkennt. Versionen in Gradle-Skripten mit eigener Logik, in Shell-Skripten oder in Pipeline-Dateien mit Variablen übersieht es mitunter. Für solche Stellen gibt es eigene Manager, in der Konfiguration customManagers mit customType: "regex". Ein häufiger Fall sind Container-Images, die als Zeichenkette im Testcode stehen. Renovate liest Java- oder TypeScript-Quelltext nicht. Die Regel für die Testdatenbank oben greift nur, wenn das Image in einer Datei steht, die Renovate kennt, etwa einer compose.yaml, oder ein solcher Manager es findet. Oft ist es einfacher, die Version an einen Ort zu verschieben, den Renovate von sich aus liest, etwa einen Versionskatalog wie libs.versions.toml.

Sicherheitsupdates warten nicht

Zeitfenster und Mindestalter sind für normale Updates gedacht. Ein Update, das eine bekannte Lücke schließt, soll nicht bis Montag warten. Renovate ignoriert für solche Updates in der Standardeinstellung von vulnerabilityAlerts das Zeitfenster und das Mindestalter, nimmt sie aus Gruppen heraus und kennzeichnet sie als Sicherheitsupdate. Der Pull Request entsteht also sofort.

Die Warnungen kommen auf GitHub aus den Sicherheitswarnungen der Plattform. Dort sind sie im Repository einzuschalten, und der Renovate-Zugang braucht Leserechte darauf. Unabhängig von der Plattform gibt es mit osvVulnerabilityAlerts eine Anbindung an die offene Datenbank OSV. Renovate kennzeichnet sie noch als experimentell, und sie deckt nicht jede Paketquelle ab. Für beide Wege gelten die Einstellungen unter vulnerabilityAlerts.

Welche Variante gilt, sollte einmal bewusst ausprobiert werden. Wer vulnerabilityAlerts im Preset anpasst, sollte prüfen, dass die Ausnahmen erhalten bleiben. Ein Sicherheitsupdate, das unbemerkt in derselben Warteschlange landet wie alle anderen, ist genau der Fall, gegen den das ganze Verfahren helfen soll.

Automatisch zusammenführen oder nicht

Der nächste Schritt liegt nahe: Updates, deren Pipeline grün ist, ohne Review übernehmen. Ich halte das für sinnvoll, aber nur unter Bedingungen. Das Repository braucht Tests, die das Verhalten wirklich prüfen, und eine Branch-Regel, die ohne grüne Pipeline nichts zusammenführt. Fehlt eines davon, ist Automerge kein Zeitgewinn, sondern ein Weg, Fehler unbemerkt in den Hauptzweig zu bringen. In einem Repository ohne aussagekräftige Tests bleibt die Prüfung von Hand nötig, bis die Tests nachgezogen sind. Die Reihenfolge ist also: zuerst die Tests, dann das automatische Zusammenführen.

Bewährt hat sich, mit Werkzeugen für die Entwicklung zu beginnen, etwa Linter oder Test-Bibliotheken:

{
  "packageRules": [
    {
      "matchDepTypes": ["devDependencies"],
      "matchUpdateTypes": ["minor", "patch"],
      "matchCurrentVersion": "!/^0/",
      "groupName": "Entwicklungswerkzeuge",
      "automerge": true
    }
  ]
}

Die Regel braucht eine eigene Gruppe. Stünden die Updates in der Gruppe für kleine Updates, würde der gemeinsame Pull Request nicht automatisch zusammengeführt, solange ein anderes Update darin kein Automerge erlaubt. devDependencies ist der Name bei npm, andere Paketmanager benennen die Typen anders. Die Bedingung !/^0/ schließt Versionen unter 1.0 aus. Nach semantischer Versionierung darf dort jede neue Version das Verhalten ändern.

Ein fachlicher Fehler in einem Entwicklungswerkzeug bricht den Build, nicht den Betrieb. Gegen Schadcode schützt das allerdings nicht. Auch ein Linter läuft in der Pipeline und sieht dort, was die Pipeline sieht. Pipelines für Update-Branches sollten deshalb ohne Zugangsdaten für Deployment und Veröffentlichung auskommen. Installationsskripte von Abhängigkeiten gehören abgeschaltet oder auf eine Liste erlaubter Pakete beschränkt. pnpm macht das ab Version 10 von sich aus. Grüne Tests sagen, dass ein Update nichts kaputt macht. Sie sagen nicht, dass es harmlos ist.

Was Automatik nicht ersetzt

Große Versionssprünge bleiben Arbeit für Menschen. Das Werkzeug öffnet den Pull Request, die Migration muss aber jemand durchführen. Der Unterschied ist, dass der Sprung sichtbar ist, sobald er möglich wird, und nicht erst, wenn er überfällig ist. Wie viel ein solcher Sprung berühren kann, zeigt jede größere Framework-Migration: geänderte Paketnamen, entfernte Schnittstellen, neue Mindestversionen der Laufzeit.

Ein Einwand kommt fast immer: Die vielen Updates erzeugen Unruhe, und jedes Update ist ein Risiko. Beides stimmt. Die Alternative ist aber nicht null Risiko, sondern ein seltenes, großes Update mit vielen gleichzeitigen Änderungen. Wenn dort etwas bricht, ist die Ursache schwer zu finden. Bei einem kleinen Update ist sie meist der Pull Request selbst.

Renovate oder Alternativen: Wann sich was lohnt

Renovate unterstützt über 90 Paketmanager auf GitHub, GitLab, Bitbucket, Azure DevOps und Gitea hinweg, doch seine enorme Konfigurationstiefe ist zugleich der häufigste Kritikpunkt. Teams, die nach Alternativen suchen, wünschen sich meist eine einfachere Konfiguration, weniger Pflegeaufwand für das Regelwerk oder eine direkte IDE-Integration.

Für reine GitHub-Teams ist Dependabot die einfachste Alternative: Eine YAML-Datei in .github/ genügt, und die Automatisierung steht, ohne externe Dienste oder wachsende Konfiguration. Bei einzelnen Projekten stiftet das mit minimalem Aufwand sofortigen Nutzen.

Sobald jedoch Regeln über viele Repositories hinweg geteilt, feingranulare Update-Gruppen gebildet oder Plattformen außerhalb von GitHub bedient werden sollen, stößt Dependabot an Grenzen. In Multi-Repo-Umgebungen zahlt sich die Einarbeitung in Renovate schnell aus: Ein zentrales Preset bündelt die Pflege an einer Stelle und senkt den laufenden Aufwand für das gesamte Team nachhaltig.

Woran man merkt, dass es wirkt

Die eingesparte Zeit lässt sich schwer messen. Gut sichtbar ist etwas anderes: Updates sind kein eigenes Vorhaben mehr, sondern Teil der Woche. Wer es genauer wissen will, schaut auf zwei Werte: wie weit die verwendeten Versionen hinter den aktuellen zurückliegen und wie lange Update-Pull-Requests offen bleiben. Steigt der zweite Wert, sind die Pull Requests zu groß oder die Tests zu schwach.

Den aktuellen Stand je Repository, also was offen, zurückgestellt oder blockiert ist, zeigt das Dependency Dashboard von Renovate. Es ist ein Issue, das Renovate selbst pflegt. Dort lässt sich ein zurückgestelltes Update auch per Häkchen anstoßen, ohne die Konfiguration zu ändern.

Das Preset ist damit selbst eine Abhängigkeit aller Repositories. Es verdient dieselbe Sorgfalt: Änderungen per Pull Request, mit Begründung, und vorher in einem Repository ausprobiert.

Thema für Ihr Projekt?

Passende Leistung: Verantwortung für ein System. Schildern Sie mir kurz, worum es geht. Ich melde mich mit einer ersten Einschätzung.

Projekt anfragen