mktools/doc/tasks/changelog.md

981 B

Tâches Changelog

make mkt-changelog

La tâche mkt-changelog permet de générer un fichier CHANGELOG.md avec l'outil git-chglog et de l'historique Git de votre projet.

L'usage de cette tâche a pour prérequis que vos messages de commit respectent la spécification "Conventional Commit".

Par défaut voici les types de commit référencés par le fichier généré:

  • feat
  • fix
  • perf
  • refactor
  • docs

Usage

Exemple d'utilisation de la tâche pour la génération du changelog du projet https://forge.cadoles.com/MyOrg/MyProject sur la forge:

my-changelog:
	$(MAKE) MKT_GIT_CHGLOG_PROJECT_ORG=MyOrg MKT_GIT_CHGLOG_PROJECT_NAME=MyProject mkt-changelog

Note

Assurez vous d'avoir créé un premier tag sur la branche en cours avant d'exécuter la tâche.