Need help with semantic-release?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

semantic-release
11.3K Stars 966 Forks 879 Commits 109 Opened issues

Description

:package::rocket: Fully automated version management and package publishing

Services available

!
?

Need anything else?

Contributors list

📦🚀 semantic-release

Fully automated version management and package publishing

Join the community on Spectrum Travis Codecov Greenkeeper semantic-release

npm latest version npm next version npm beta version

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

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 or commitlint 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:

| Commit message | Release type | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| |

fix(pencil): stop graphite breaking when too much pressure applied
| Patch Release | |
feat(pencil): add 'graphiteWidth' option
| ~~Minor~~ Feature Release | |
perf(pencil): remove graphiteWidth option


BREAKING CHANGE: The graphiteWidth option has been removed.

The default graphite width of 10mm is always used for performance reasons.
| ~~Major~~ Breaking Release |

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 one of the release branches (for example

master
,
next
,
beta
), 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.

semantic-release offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes: - Using distribution channels - Maintenance releases - Pre-releases

Release steps

After running the tests, the command

semantic-release
will execute the following steps:

| Step | Description | |-------------------|---------------------------------------------------------------------------------------------------------------------------------| | Verify Conditions | Verify all the conditions to proceed with the release. | | Get last release | Obtain the commit corresponding to the last release by analyzing Git tags. | | Analyze commits | Determine the type of release based on the commits added since the last release. | | Verify release | Verify the release conformity. | | Generate notes | Generate release notes for the commits added since the last release. | | Create Git tag | Create a Git tag corresponding to the new release version. | | Prepare | Prepare the release. | | Publish | Publish the release. | | Notify | Notify of new releases or errors. |

Requirements

In order to use semantic-release you need: - To host your code in a Git repository - Use a Continuous Integration service that allows you to securely set up credentials - Git CLI version 2.7.1 or higher installed in your Continuous Integration environment - Node.js version 10.18 or higher installed in your Continuous Integration environment

Documentation

Get help

Badge

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

semantic-release

[![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

| Gregor Martynus | Pierre Vanduynslager | Matt Travi | | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | | Gregor Martynus | Pierre Vanduynslager | Matt Travi |

Alumni

| Stephan Bönnemann | Rolf Erik Lekang | Johannes Jörg Schmidt | Finn Pauls | Christoph Witzko | | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | Stephan Bönnemann | Rolf Erik Lekang | Johannes Jörg Schmidt | Finn Pauls | Christoph Witzko |

Kill all humans

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.