So automatisierst du CI/CD in einem Lerna-Monorepo

Vielleicht hast du schon unseren letzten Blogpost gelesen, in dem wir zeigen, wie wir mit einem Monorepo eine Sammlung von React Micro Frontend Components gebaut haben: React Micro Frontend Components in einem Monorepo
Willst du mehr über das technische Setup erfahren und darüber, wie wir den Release-Prozess integriert und automatisiert haben?
In diesem Post erfährst du, wie du das Monorepo mit Lerna verwaltest und es mit Gitlab CI in eine Continuous-Integration- und Continuous-Delivery-Pipeline einbindest.
Pipelines
Wir verwenden das Gitlab-Flow-Branching-Modell mit Tags, um Releases zu markieren. Jedes Feature und jeder Fix wird in einem eigenen Branch entwickelt. Sobald etwas bereit fürs Review ist, eröffnen wir einen Pull Request. So stellen wir das Vier-Augen-Prinzip sicher und halten den Master-Branch stabil.

Hier startet die erste Pipeline. Jede Codeänderung in einem Feature- oder Fix-Branch löst die Unit- und Integrationstests sowie die Prüfung der Linting-Regeln aus.
Nach dem Merge und erfolgreichen Testläufen der Pipeline auf dem Master-Branch lässt sich der Semantic Release über einen manuellen oder automatisierten CI-Job auslösen. Dafür verwenden wir den Befehl lerna version, der zwei Dinge erledigt:
- Er erstellt für jedes Package einen neuen Git-Tag mit dessen Änderungen und
- Er publiziert die neuen Package-Versionen auf NPM
Lerna
Für unser Monorepo-Setup verwenden wir Lerna. Es bietet alle Prozesse und Utilities, die es für die Verwaltung des Monorepos braucht. Wir haben es eng in unsere Gitlab-CI-Release-Pipeline integriert, damit neue Releases automatisch und konsistent erstellt werden.
Standardmässig führt Gitlab CI die CI-Jobs in einem Detached-HEAD-Zustand des Repository-Baums aus. Deshalb kann Lerna den aktuellen Branch und die Git-History nicht korrekt bestimmen und scheitert beim Publizieren einer neuen Version der Packages.
Das Problem ist auch im folgenden Github-Issue des Lerna-Projekts beschrieben.
Wir lösen das Problem, indem wir zuerst den aktuellen Branch der Pipeline auschecken:
# clone the repository
git clone "https://${GL_USER}:${GL_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git" dist &> /dev/null
cd dist
git checkout ${CI_COMMIT_REF_NAME}
git pull origin ${CI_COMMIT_REF_NAME}
npm install
# create new git version tags
lerna version --yes
# publish the new git versions to npm
lerna publish from-git --yesConventional Commits und Semantic Versioning
Wir halten uns strikt an Semantic Versioning und verwenden Conventional Commits.
Das heisst, jeder Commit, der in den Master gemergt wird, muss die Form fix: correct minor typos in code haben. So kann der Semantic-Release-Prozess von Lerna unterscheiden, ob er einen neuen Major-, Minor- oder Patch-Release der entsprechenden Komponente erstellen soll.
Das ist unsere lerna.json-Datei mit der Konfiguration, die Conventional Commits und Semantic Versioning berücksichtigt:
{
"packages" : ["packages/*"],
"version": "independent",
"command": {
"version": {
"createRelease": "gitlab",
"conventionalCommits": true,
"allowBranch": ["master"],
"message": "chore(release): publish"
}
}
}Wie hast du die Entwicklung und das Deployment deiner Applikationen automatisiert? Wir freuen uns, von deinen Erfahrungen zu hören! Melde dich bei uns!

Geschrieben von
Thilo Haas
Ähnliche Challenge auf dem Tisch? Lass uns drüber reden.





