26 lines
981 B
Markdown
26 lines
981 B
Markdown
|
# 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`](https://github.com/git-chglog/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"](https://www.conventionalcommits.org/fr/v1.0.0/).
|
||
|
|
|
||
|
|
Par défaut voici [les types de commit](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) 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:
|
||
|
|
|
||
|
|
```makefile
|
||
|
|
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.
|