semantic-release/semantic-release


packagerocket Fully automated version management and package publishing

https://semantic-release.gitbook.io

License: MIT

Language: JavaScript

Keywords: git, github, npm, publish, release, release-automation, release-management, release-notes, semantic-release, semver, version-control, version-manager, versioning


📦🚀 semantic-release

Fully automated version management and package publishing

Gitter Travis Codecov Greenkeeper semantic-release

Waffle.io

npm latest version npm next 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, commitlint or semantic-git-commit-cli can be used to help contributors and enforce valid commit messages.

Here is an example of the release type that will be done based on a commit messages:

Commit message Release type
fix(pencil): stop graphite breaking when too much pressure applied Patch 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 commits added to the release branch (i.e. master) 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.

If you need more control over the timing of releases you have a couple of options:

  • Publish releases on a distribution channel (for example npm’s dist-tags). This way you can keep control over what your users end up using by default, and you can decide when to make an automatically released version available to the stable channel, and promote it.
  • Develop on a dev branch and merge it to the release branch (i.e. master) once you are ready to publish. semantic-release will run only on pushes to the release branch.

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.

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

Stephan Bönnemann Rolf Erik Lekang Johannes Jörg Schmidt Gregor Martynus Pierre Vanduynslager Pierre Vanduynslager Christoph Witzko
Stephan Bönnemann Rolf Erik Lekang Johannes Jörg Schmidt Gregor Martynus Finn Pauls Pierre Vanduynslager Christoph Witzko

Kill all humans

Project Statistics

Sourcerank 21
Repository Size 1.18 MB
Stars 5,836
Forks 395
Watchers 91
Open issues 15
Dependencies 46
Contributors 71
Tags 201
Created
Last updated
Last pushed

Top Contributors See all

Pierre Vanduynslager Stephan Bönnemann greenkeeper[bot] Greenkeeper Gregor Martynus Christoph Witzko Kaito Udagawa Felix Becker Richard Littauer William Hosford Vladimir Krivosheev Colle Tom Vincent Cory Reed Matteo Ronchi Robin Mehner David Pfahler robert Hans Kristian Flaatten Mark Dalgleish

Packages Referencing this Repo

semantic-release
Automated semver compliant package publishing
Latest release 16.0.0-beta.2 - Updated - 5.84K stars
@develar/semantic-release
automated semver compliant package publishing
Latest release 6.3.26 - Updated - 5.84K stars
@pvdlg/semantic-release
Automated semver compliant package publishing
Latest release 1.0.2 - Updated - 5.84K stars
semantic-release-no-travis
automated semver compliant package publishing
Latest release 6.4.0 - Published - 5.84K stars

Recent Tags See all

v16.0.0-beta.2@beta November 30, 2018
v15.12.4 November 30, 2018
v16.0.0-beta.1@beta November 30, 2018
v15.12.3 November 28, 2018
v15.12.2 November 26, 2018
v15.12.1 November 21, 2018
v15.12.0 November 14, 2018
v15.11.0 November 12, 2018
v15.10.8 November 06, 2018
v15.10.7 November 02, 2018
v15.10.6 October 27, 2018
v15.10.5 October 20, 2018
v15.10.4 October 20, 2018
v15.10.3 October 17, 2018
v15.10.2 October 09, 2018

Interesting Forks See all

atlassian/lerna-semantic-release
📦:🛠✨💥 – fully automated package publishing
JavaScript - Last pushed - 245 stars - 20 forks
pvdlg/semantic-release
packagerocket Fully automated version management and package publishing
JavaScript - MIT - Updated - 1 stars
AMANDAVE/semantic-release
packagerocket fully automated package publishing
JavaScript - Updated - 1 stars
CNXTEoE/semantic-release
packagerocket fully automated package publishing
JavaScript - Updated - 1 stars
niilante/semantic-release
packagerocket fully automated package publishing
JavaScript - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2018-11-30 04:18:55 UTC

Login to resync this repository