Notoriously Punctual Manatee

    semantic-release
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/semantic-release package

    18.0.1 • Public • Published

    📦🚀 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 and communicating the impact of changes to consumers.

    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 consumer impact 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 message Release type
    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 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 commit 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:

    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:

    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/semantic-release-e10079.svg?logo=semantic-release)](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

    Install

    npm i semantic-release

    DownloadsWeekly Downloads

    702,813

    Version

    18.0.1

    License

    MIT

    Unpacked Size

    254 kB

    Total Files

    65

    Last publish

    Collaborators

    • travi
    • pvdlg
    • semantic-release-bot
    • gr2m