Déployer un package sur npm de manière automatisée et en respectant SemVer avec semantic-release

Respecter SemVer (presque) sans avoir à y penser avec semantic-release

sur putaindecode.io

Semantic Versioning

X.Y.Z

1.0.0

SemVer est un contrat que vous signez avec vos utilisateurs, une forme de respect qui leur permet d'adapter leur code ou non en fonction des versions que vous proposez.

-- « SemVer, c'est quoi ? », putaindecode.io

Publier un module sur npm

Incrémente X, Y ou Z dans le package.json; crée un commit de version et un tag

Documentation

$ npm version [major | minor | patch]

Envoie les fichiers du module sur le registry npm

Documentation

$ npm publish

Alors, quel est le problème ?

Problème n°1 : nous sommes humains

after all.

Angular Commit Messages Guidelines

type(scope): subject

body

footer

feat(pencil): add 'graphiteWidth' option

fix(graphite): stop graphite breaking when width < 0.1

Closes #28

perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.

Problème n°2 : une release, ce n'est pas qu'une incrémentation du numéro de version et une publication sur le registry

Exemple de cozy-ui

• Mettre à jour le master local

• Incrémenter la version dans le package.json (en respectant semver)

• Mettre à jour le changelog (à générer avec lerna-changelog, qui se base sur les tags des PR pour savoir ce qui est un fix, une feature, un breaking change)

• Mettre à jour les liens en bas du changelog

• Commit et push ces changements

• Créer la release dans l'interface Github

feat(pencil): add 'graphiteWidth' option

perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.

fix(graphite): stop graphite breaking when width < 0.1

Closes #28

Bug fixes

• Graphite
  • Stop graphite breaking when width < 0.1

New features

• Pencil
  • add 'graphiteWidth' option

Performance improvements

• Pencil
  • Remove graphiteWidth option

Breaking changes

• The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason

Problème n°3 : pourquoi attendre n commits / PRs pour sortir une release ?

AUTOMATISER

Une seule solution :

📦🚀 semantic-release

Fully automated version management and package publishing

Push sur la
« release branch »

Build CI

Tests

Release

La publication d'une nouvelle release ne nécessite plus d'autre action humaine qu'un git push

Démo ?

Démo !