Release proces voor NDW Design op NPM

NDW Design wordt als een publieke package gepubliceerd op NPM, wat betekent dat het voor iedereen beschikbaar is om te gebruiken.

Het is cruciaal om bij elke release van een package semantic versioning te volgen. Dit systeem maakt het eenvoudig voor gebruikers om te begrijpen wat er in een nieuwe versie is veranderd en welke impact dit kan hebben op hun projecten.

Semantic Versioning

NDW Design volgt het principe van Semantic Versioning. Dit is een standaard die het versienummer in drie segmenten verdeelt: MAJOR.MINOR.PATCH.

• MAJOR: Wordt verhoogd wanneer er breaking changes zijn die niet compatibel zijn met eerdere versies.
• MINOR: Wordt verhoogd wanneer er nieuwe features worden toegevoegd die backward-compatible zijn.
• PATCH: Wordt verhoogd bij backward-compatible bugfixes.

Het is belangrijk om de juiste versie te bepalen door het versienummer te verhogen op basis van de aard van de veranderingen sinds de laatste release.

Stappenplan voor het aanmaken van een release branch

1. Ga naar de main branch: Zorg ervoor dat je op de main branch werkt door git checkout main te gebruiken.
2. Haal de laatste wijzigingen binnen: Zorg ervoor dat je de meest recente versie van de main branch hebt door git pull uit te voeren.
3. Controleer de geplande features: Zorg ervoor dat alle features die in de komende release moeten worden opgenomen aanwezig zijn.
4. Maak een nieuwe release branch aan: Creëer een nieuwe branch op basis van de main branch met het commando git checkout -b chore/release-*-*-*.
   • Vervang de asterisks (*) door het juiste versienummer volgens de wijzigingen die zijn doorgevoerd (zie "Semantic Versioning").
5. Werk het CHANGELOG.md bestand bij: Voeg alle relevante veranderingen, toevoegingen en fixes toe aan het changelog.
6. Verhoog het versienummer in package.json: Ga naar projects/ndw/ en pas het versienummer in de package.json aan op basis van de wijzigingen.
   • Vervang de asterisks (*) door het juiste versienummer.
7. Commit je wijzigingen: Sla je wijzigingen op met het commando git commit -m "chore(package): release *.*.*".
8. Vraag om goedkeuring: Wacht totdat er minimaal twee goedkeuringen (approvals) zijn op je pull request voordat je verder gaat met het publiceren. Zie het volgende stappenplan ("Publiceren naar NPM") voor de publicatieprocedure.

Publiceren naar NPM

1. Open de terminal in de root van de repository.
2. Log in bij NPM: Zorg ervoor dat je bent ingelogd met je NPM-account via de CLI door npm login uit te voeren.
   • Ben je nog geen lid van de NPM Organization "ndwnu"? Neem dan contact op met Jurrit van der Ploeg via Slack.
3. Run de build command: Voer de build uit voor de package met bijvoorbeeld: npm run build:package:ndw.
4. Publiceer de package: Als de build succesvol is, voer dan het publicatiecommando uit, bijvoorbeeld: npm run publish:ndw.
5. Controleer de publicatie: Nadat je de package hebt gepubliceerd, kun je controleren of deze correct is toegevoegd door te zoeken naar je package op npmjs.com.
6. Communiceer de release: Informeer je team en gebruikers over de nieuwe release door een bericht te plaatsen in het Slack-kanaal "ndw-designsystem-algemeen".