VVL-REGEX

Semantic Release Commit Conventions

Deze repository volgt de conventionele commit specificatie om de release workflow te automatiseren via Semantic Release. Hieronder vind je de richtlijnen voor het gebruik van commit types en het aangeven van breaking changes.

Gewone Commit Types

feat

Gebruik feat wanneer je een nieuwe feature toevoegt aan de codebase.

Voorbeeld commit message: feat: voeg nieuwe zoekfunctionaliteit toe

fix

Gebruik fix wanneer je een bug oplost in de codebase.

Voorbeeld commit message: fix: herstel fout bij inloggen

Breaking Changes

Er zijn twee manieren om aan te geven dat een commit een breaking change bevat:

1. Uitroepteken toevoegen

Voeg direct na het commit-type een ! toe.

Voorbeelden commit messages:

• feat!: breaking feature
• fix!: breaking fix

Dit geeft direct aan dat de commit een breaking change bevat.

2. BREAKING CHANGE Footer

Voeg in de commit message een aparte regel toe die begint met BREAKING CHANGE:, gevolgd door een uitleg van de wijziging.

Voorbeeld: feat: voeg nieuwe functionaliteit toe

BREAKING CHANGE: De API endpoints zijn aangepast, dit kan brekend werken voor bestaande integraties.

Versienummer Bepaling

Semantic Release gebruikt de conventionele commit messages om automatisch de volgende versie van je project te bepalen:

• Patch Release: Bij commits met alleen fix (zonder breaking changes) wordt het patchnummer verhoogd (bijv. van 1.2.3 naar 1.2.4).
• Minor Release: Bij commits met feat zonder breaking changes wordt het minor nummer verhoogd (bijv. van 1.2.3 naar 1.3.0).
• Major Release: Bij commits met breaking changes (door ! of een BREAKING CHANGE: footer) wordt het major nummer verhoogd (bijv. van 1.2.3 naar 2.0.0).

Samenvatting

• Gebruik feat voor nieuwe functionaliteiten en fix voor bugfixes.
• Gebruik ! of een BREAKING CHANGE: footer om breaking changes aan te geven.
• Deze conventies helpen Semantic Release automatisch de juiste versie-updates (major, minor, patch) toe te wijzen.