📦🚀 semantic-release

Fully automated version management and package publishing

semantic-release automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.

This removes the immediate connection between human emotions and version numbers, strictly following the Semantic Versioning specification.

> Trust us, this will change your workflow for the better. – egghead.io

Highlights

• Fully automated release
• Enforce Semantic Versioning specification
• New features and fixes are immediately available to users
• Notify maintainers and users of new releases
• Use formalized commit message convention to document changes in the codebase
• Integrate with your continuous integration workflow
• Avoid potential errors associated with manual releases
• Support any package managers and languages via plugins
• Simple and reusable configuration via shareable configurations

How does it work?

Commit message format

semantic-release uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.

By default semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset or config options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.

Tools such as commitizen, commitlint or semantic-git-commit-cli can be used to help contributors and enforce valid commit messages.

Here is an example of the release type that will be done based on a commit messages:

Automation with CI

semantic-release is meant to be executed on the CI environment after every successful build on the release branch. This way no human is directly involved in the release process and the releases are guaranteed to be unromantic and unsentimental.

Triggering a release

For each new commits added to the release branch (i.e. master) with git push or by merging a pull request or merging from another branch, a CI build is triggered and runs the semantic-release command to make a release if there are codebase changes since the last release that affect the package functionalities.

If you need more control over the timing of releases you have a couple of options:

• Publish releases on a distribution channel (for example npm’s dist-tags). This way you can keep control over what your users end up using by default, and you can decide when to make an automatically released version available to the stable channel, and promote it.
• Develop on a dev branch and merge it to the release branch (i.e. master) once you are ready to publish. semantic-release will run only on pushes to the release branch.

Release steps

After running the tests, the command semantic-release will execute the following steps:

Documentation

• Usage
  • Getting started
  • Installation
  • CI Configuration
  • Configuration
  • Plugins
  • Shareable configurations
• Extending
  • Plugins
  • Shareable configuration
• Recipes
  • CI configurations
  • Package managers and languages
• Developer guide
  • JavaScript API
  • Plugins
  • Shareable configuration
• Support
  • Resources
  • Frequently Asked Questions
  • Troubleshooting
  • Node version requirement
  • Node Support Policy

Get help

• Stack Overflow
• Spectrum community
• Twitter

Badge

Let people know that your package is published using semantic-release by including this badge in your readme.

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Team

Stephan Bönnemann	Rolf Erik Lekang	Johannes Jörg Schmidt	Gregor Martynus	Finn Pauls	Pierre Vanduynslager	Christoph Witzko