conventional changelog

Changelog conventionnel

Générez un Changelog à partir des métadonnées GIT.

À propos de ce repo

Le dépôt conventionnel-changelog est géré comme monorepo; Il est composé de nombreux packages NPM.

Le dépôt d'API conventional-changelog/conventional-changelog d'origine peut être trouvé dans les packages / le change-changel conventionnel.

Commencer

Il est recommandé d'utiliser la bibliothèque de commit-et-tag-version de haut niveau, qui remplace la commande version de NPM, gérant la version automatisée, le taggage et la génération de modifications.

Alternativement, si vous souhaitez vous déplacer vers l'automatisation complètement de votre processus de publication en tant que sortie de CI / CD, envisagez d'utiliser la libération sémantique.

Vous pouvez également utiliser l'un des plugins si vous utilisez déjà l'outil:

Plugins prenant en charge le changelog conventionnel

• grognement
• gorgée
• atome
• vscode
• emacs

Modules importants pour l'écosystème conventionnel de changelog

• CONNONGENTIONNEL CHANGELOG-CLI - L'interface de ligne de commande complète
• Interface de ligne de commande standard-changelog pour le format de validation angulaire.
• conventionnel-github-releaser - Faites une nouvelle version github à partir des métadonnées GIT
• Bump conventionnel-recommandé - Obtenez une bosse de version recommandée basée sur les validations conventionnelles
• Détecteur conventionnel-Commits - Détectez la convention de messages de validation que votre référentiel utilise
• Commizen - Conventions de validation simples pour les citoyens sur Internet.
• commitlint - peluche commit les messages

Politique de support de nœud

Nous prenons uniquement des versions de support à long terme de Node.

Nous limitons spécifiquement notre support aux versions LTS de Node, non pas parce que ce package ne fonctionnera pas sur d'autres versions, mais parce que nous avons un temps limité, et que le soutien LTS offre le plus grand retour sur cet investissement.

Il est possible que ce package fonctionne correctement sur les versions plus récentes de Node. Il peut même être possible d'utiliser ce package sur des versions anciennes de Node, bien que cela soit plus improbable, car nous ferons tout notre possible pour profiter des fonctionnalités disponibles dans la version LTS la plus ancienne que nous prenons en charge.

Alors que chaque version LTS Node atteint sa fin de vie, nous supprimerons cette version de la propriété node engines du fichier package.json de notre package. La suppression d'une version de nœud est considérée comme un changement de rupture et impliquera la publication d'une nouvelle version majeure de ce package. Nous n'accepterons aucune demande de prise en charge d'une version de fin de vie de Node. Toutes les demandes ou problèmes de fusion prenant en charge une version de fin de vie de nœud seront fermés.

Nous accepterons le code qui permet à ce package d'exécuter des versions plus récentes, non LTS, de nœud. De plus, nous tenterons de garantir que nos propres modifications fonctionnent sur la dernière version de Node. Pour aider à cet engagement, notre configuration d'intégration continue fonctionne contre toutes les versions LTS de Node en plus de la version de nœud la plus récente; appelé courant .

Les gestionnaires de packages JavaScript devraient vous permettre d'installer ce package avec n'importe quelle version de Node, avec, tout au plus, un avertissement si votre version de nœud ne se situe pas dans la plage spécifiée par la propriété de nos engines node . Si vous rencontrez des problèmes d'installation de ce package, veuillez signaler le problème à votre gestionnaire de packages.