Semantic Release

📦🚀 Fully automated version management and package publishing
Alternatives To Semantic Release
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Semantic Release18,68920,12731,138a day ago366July 05, 2023336mitJavaScript
:package::rocket: Fully automated version management and package publishing
Edk23,841
2 days ago160otherC
EDK II
Add And Commit945
5 days ago8mitTypeScript
:octocat: Automatically commit changes made in your workflow run directly to your repo
Unit Test Demo771
10 months ago1September 24, 201913JavaScript
一步一步介绍如何给项目添加单元测试
Seleniumhq.github.io699
a day ago55apache-2.0HTML
Official Selenium website and documentation
How To Use Travis Ci422
5 years ago1apache-2.0Java
如何简单入门持续集成( Travis-CI ) http://travis-ci.org/
Cob381
3 months ago6April 20, 20207mitGo
Continuous Benchmark for Go Project
Golang Monorepo330
5 months ago10August 30, 20203mitShell
An example of a golang-based monorepo.
Travis Watch294222 years ago53August 22, 20197mitJavaScript
Stream live travis test results of the current commit to your terminal!
Wp Dev Lib285156a year ago23October 16, 202052mitShell
DEPRECATED. Common code used during development of WordPress plugins and themes
Alternatives To Semantic Release
Select To Compare


Alternative Project Comparisons
Readme

📦🚀 semantic-release

Fully automated version management and package publishing

Join the community on GitHub Discussions Build states OpenSSF Scorecard semantic-release: angular

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
(Note that the BREAKING 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 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 and which commit-convention is followed by including this badge in your readme.

semantic-release: angular

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?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

Popular Commit Projects
Popular Continuous Integration Projects
Popular Version Control Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Javascript
Commit
Ci
Changelog
Semver
Release Automation