README
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 theSemantic Versioning specification and communicating theimpact of changes to consumers.
Trust us, this will change your workflow for the better. –egghead.io
Highlights
Fully automated release
EnforceSemantic 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
Publish on different distribution channels (such asnpm dist-tags) based on git merges
Integrate with yourcontinuous integration workflow
Avoid potential errors associated with manual releases
Support anypackage managers and languages viaplugins
Simple and reusable configuration viashareable configurations
Support fornpm package provenance that promotes increased supply-chain security via signed attestations on GitHub Actions
How does it work?
Commit message format
semantic-release uses the commit messages to determine the consumer impact of changes in the codebase.Following formalized conventions for commit messages,semantic-release automatically determines the nextsemantic version number, generates a changelog and publishes the release.
By default,semantic-release usesAngular Commit Message Conventions.The commit message format can be changed with thepreset orconfig options of the@semantic-release/commit-analyzer and@semantic-release/release-notes-generator plugins.
Tools such ascommitizen orcommitlint can be used to help contributors and enforce valid commit messages.
The table below shows which commit message gets you which release type whensemantic-release runs (using the default configuration):
fix(pencil): stop graphite breaking when too much pressure applied
Patch Fix Release
feat(pencil): add 'graphiteWidth' option
Minor Feature Release
perf(pencil): remove graphiteWidth optionBREAKING CHANGE: The graphiteWidth option has been removed.The default graphite width of 10mm is always used for performance reasons.
Major Breaking Release(Note that theBREAKING CHANGE:token must be in the footer of the commit)
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 beunromantic and unsentimental.
Triggering a release
For each new commit added to one of the release branches (for example:master,main,next,beta), withgit push or by merging a pull request or merging from another branch, a CI build is triggered and runs thesemantic-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 commandsemantic-release will execute the following steps:
Verify Conditions
Verify all the conditions to proceed with the release.
Get last release
Obtain the commit corresponding to the last release by analyzingGit 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 usesemantic-release you need:
To host your code in aGit repository
Use a Continuous Integration service that allows you tosecurely set up credentials
A Git CLI version that meetsour version requirement installed in your Continuous Integration environment
ANode.js version that meetsour version requirement installed in your Continuous Integration environment
Documentation
Extending
Get help
Badge
Let people know that your package is published usingsemantic-release and whichcommit-convention is followed by including this badge in your readme.
[](https://github.com/semantic-release/semantic-release)Team
Alumni
Last updated