npm.devtool.tech
👏 You can access semantic-release package with using semanticRelease variable in browser devtools!
Automated semver compliant package publishing

code/package/bundle size

0B
publish
0B
install
0B
bundle minified
0B
bundle gzipped

📦🚀 semantic-release

Fully automated version management and package publishing

Join the community on GitHub Discussions Build states 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.

The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Commit messageRelease type
fix(pencil): stop graphite breaking when too much pressure appliedPatch Release
feat(pencil): add 'graphiteWidth' optionMinor 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:

Release steps

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

StepDescription
Verify ConditionsVerify all the conditions to proceed with the release.
Get last releaseObtain the commit corresponding to the last release by analyzing Git tags.
Analyze commitsDetermine the type of release based on the commits added since the last release.
Verify releaseVerify the release conformity.
Generate notesGenerate release notes for the commits added since the last release.
Create Git tagCreate a Git tag corresponding to the new release version.
PreparePrepare the release.
PublishPublish the release.
NotifyNotify of new releases or errors.

Requirements

In order to use semantic-release you need:

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 MartynusPierre VanduynslagerMatt Travi
Gregor MartynusPierre VanduynslagerMatt Travi

Alumni

Stephan BönnemannRolf Erik LekangJohannes Jörg SchmidtFinn PaulsChristoph Witzko
Stephan BönnemannRolf Erik LekangJohannes Jörg SchmidtFinn PaulsChristoph Witzko

Kill all humans

🔎Explore Package🔎CDN Script

Score

Popularity53/100
Quality77/100
Maintenance98/100