semantic-release
AboutGitHubNeed Help?
master
master
  • README
  • Usage
    • Getting started
    • Installation
    • CI Configuration
    • Configuration
    • Plugins
    • Release Workflow configuration
    • Shareable configurations
  • Extending
    • Plugins
    • Shareable configuration
  • Recipes
    • CI configurations
      • CircleCI 2.0
      • Travis CI
      • GitLab CI
      • GitHub Actions
      • Jenkins CI
    • Git hosted services
      • Git authentication with SSH keys
    • Release Workflow
      • Publishing on distribution channels
      • Publishing maintenance releases
      • Publishing pre-releases
  • Developer guide
    • JavaScript API
    • Plugin development
    • Shareable configuration development
  • Support
    • Resources
    • Frequently Asked Questions
    • Troubleshooting
    • Node version requirement
    • Node Support Policy
    • Git version requirement
Powered by GitBook
On this page
  • Fully automated version management and package publishing
  • Highlights
  • How does it work?
  • Commit message format
  • Automation with CI
  • Triggering a release
  • Release steps
  • Requirements
  • Documentation
  • Get help
  • Badge
  • Team
  • Alumni
Edit on GitHub

README

NextGetting started

Last updated 1 month ago

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

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

Highlights

  • Fully automated release

  • Enforce 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 as ) based on git merges

  • Integrate with your

  • Avoid potential errors associated with manual releases

  • Support any via

  • Simple and reusable configuration via

  • Support for that promotes increased supply-chain security via signed attestations on GitHub Actions

How does it work?

Commit message format

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 (Note that the BREAKING CHANGE: token must be in the footer of the commit)

Automation with CI

Triggering a release

For each new commit added to one of the release branches (for example: master, main, 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

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

  • Usage

  • Extending

  • Recipes

  • Developer guide

  • Support

Get help

Badge

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

Team

Alumni

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 number, generates a changelog and publishes the release.

By default, semantic-release uses . The commit message format can be changed with the of the and plugins.

Tools such as or can be used to help contributors and enforce valid commit messages.

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 .

Obtain the commit corresponding to the last release by analyzing .

To host your code in a

Use a Continuous Integration service that allows you to

A Git CLI version that meets installed in your Continuous Integration environment

A version that meets installed in your Continuous Integration environment

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

semantic version
commitizen
commitlint
unromantic and unsentimental
Git repository
our version requirement
Node.js
our version requirement
Getting started
Installation
CI Configuration
Plugins
Workflow configuration
Shareable configurations
Plugins
Shareable configuration
CI configurations
Git hosted services
Release workflow
JavaScript API
Plugins development
Shareable configuration development
Resources
Frequently Asked Questions
Troubleshooting
Node version requirement
Node Support Policy
GitHub Discussions
Stack Overflow
Twitter
commit-convention
Git tags
Gregor Martynus
Pierre Vanduynslager
Matt Travi
Stephan Bönnemann
Rolf Erik Lekang
Johannes Jörg Schmidt
Finn Pauls
Christoph Witzko
Semantic Versioning
egghead.io
Semantic Versioning
npm dist-tags
plugins
shareable configurations
npm package provenance
Angular Commit Message Conventions
@semantic-release/commit-analyzer
@semantic-release/release-notes-generator
securely set up credentials
Pre-releases
Using distribution channels
Maintenance releases
continuous integration workflow
package managers and languages
preset or config options
Configuration
Kill all humans