| 1 | <h1 align="center" style="border-bottom: none;">📦🚀 semantic-release</h1>
|
| 2 | <h3 align="center">Fully automated version management and package publishing</h3>
|
| 3 | <p align="center">
|
| 4 | <a href="https://spectrum.chat/semantic-release">
|
| 5 | <img alt="Join the community on Spectrum" src="https://withspectrum.github.io/badge/badge.svg">
|
| 6 | </a>
|
| 7 | <a href="https://travis-ci.org/semantic-release/semantic-release">
|
| 8 | <img alt="Travis" src="https://img.shields.io/travis/semantic-release/semantic-release/master.svg">
|
| 9 | </a>
|
| 10 | <a href="https://codecov.io/gh/semantic-release/semantic-release">
|
| 11 | <img alt="Codecov" src="https://img.shields.io/codecov/c/github/semantic-release/semantic-release/master.svg">
|
| 12 | </a>
|
| 13 | <a href="https://greenkeeper.io">
|
| 14 | <img alt="Greenkeeper" src="https://badges.greenkeeper.io/semantic-release/semantic-release.svg">
|
| 15 | </a>
|
| 16 | <a href="#badge">
|
| 17 | <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
|
| 18 | </a>
|
| 19 | </p>
|
| 20 | <p align="center">
|
| 21 | <a href="https://www.npmjs.com/package/semantic-release">
|
| 22 | <img alt="npm latest version" src="https://img.shields.io/npm/v/semantic-release/latest.svg">
|
| 23 | </a>
|
| 24 | <a href="https://www.npmjs.com/package/semantic-release">
|
| 25 | <img alt="npm next version" src="https://img.shields.io/npm/v/semantic-release/next.svg">
|
| 26 | </a>
|
| 27 | <a href="https://www.npmjs.com/package/semantic-release">
|
| 28 | <img alt="npm beta version" src="https://img.shields.io/npm/v/semantic-release/beta.svg">
|
| 29 | </a>
|
| 30 | </p>
|
| 31 |
|
| 32 | **semantic-release** automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.
|
| 33 |
|
| 34 | This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](http://semver.org) specification.
|
| 35 |
|
| 36 | > Trust us, this will change your workflow for the better. – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release)
|
| 37 |
|
| 38 | ## Highlights
|
| 39 |
|
| 40 | - Fully automated release
|
| 41 | - Enforce [Semantic Versioning](https://semver.org) specification
|
| 42 | - New features and fixes are immediately available to users
|
| 43 | - Notify maintainers and users of new releases
|
| 44 | - Use formalized commit message convention to document changes in the codebase
|
| 45 | - Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
|
| 46 | - Integrate with your [continuous integration workflow](docs/recipes/README.md#ci-configurations)
|
| 47 | - Avoid potential errors associated with manual releases
|
| 48 | - Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
|
| 49 | - Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)
|
| 50 |
|
| 51 | ## How does it work?
|
| 52 |
|
| 53 | ### Commit message format
|
| 54 |
|
| 55 | **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](https://semver.org) number, generates a changelog and publishes the release.
|
| 56 |
|
| 57 | By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
|
| 58 |
|
| 59 | Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint](https://github.com/conventional-changelog/commitlint) can be used to help contributors and enforce valid commit messages.
|
| 60 |
|
| 61 | Here is an example of the release type that will be done based on a commit messages:
|
| 62 |
|
| 63 | | Commit message | Release type |
|
| 64 | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
|
| 65 | | `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
|
| 66 | | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
|
| 67 | | `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
|
| 68 |
|
| 69 | ### Automation with CI
|
| 70 |
|
| 71 | **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](http://sentimentalversioning.org).
|
| 72 |
|
| 73 | ### Triggering a release
|
| 74 |
|
| 75 | For each new commits 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.
|
| 76 |
|
| 77 | **semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:
|
| 78 | - [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
|
| 79 | - [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases)
|
| 80 | - [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases)
|
| 81 |
|
| 82 | ### Release steps
|
| 83 |
|
| 84 | After running the tests, the command `semantic-release` will execute the following steps:
|
| 85 |
|
| 86 | | Step | Description |
|
| 87 | |-------------------|---------------------------------------------------------------------------------------------------------------------------------|
|
| 88 | | Verify Conditions | Verify all the conditions to proceed with the release. |
|
| 89 | | Get last release | Obtain the commit corresponding to the last release by analyzing [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging). |
|
| 90 | | Analyze commits | Determine the type of release based on the commits added since the last release. |
|
| 91 | | Verify release | Verify the release conformity. |
|
| 92 | | Generate notes | Generate release notes for the commits added since the last release. |
|
| 93 | | Create Git tag | Create a Git tag corresponding to the new release version. |
|
| 94 | | Prepare | Prepare the release. |
|
| 95 | | Publish | Publish the release. |
|
| 96 | | Notify | Notify of new releases or errors. |
|
| 97 |
|
| 98 | ## Requirements
|
| 99 |
|
| 100 | In order to use **semantic-release** you need:
|
| 101 | - To host your code in a [Git repository](https://git-scm.com)
|
| 102 | - Use a Continuous Integration service that allows you to [securely set up credentials](docs/usage/ci-configuration.md#authentication)
|
| 103 | - Git CLI version [2.7.1 or higher](docs/support/FAQ.md#why-does-semantic-release-require-git-version--271) installed in your Continuous Integration environment
|
| 104 | - [Node.js](https://nodejs.org) version [10.18 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--1018) installed in your Continuous Integration environment
|
| 105 |
|
| 106 | ## Documentation
|
| 107 |
|
| 108 | - Usage
|
| 109 | - [Getting started](docs/usage/getting-started.md#getting-started)
|
| 110 | - [Installation](docs/usage/installation.md#installation)
|
| 111 | - [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
|
| 112 | - [Configuration](docs/usage/configuration.md#configuration)
|
| 113 | - [Plugins](docs/usage/plugins.md)
|
| 114 | - [Workflow configuration](docs/usage/workflow-configuration.md)
|
| 115 | - [Shareable configurations](docs/usage/shareable-configurations.md)
|
| 116 | - Extending
|
| 117 | - [Plugins](docs/extending/plugins-list.md)
|
| 118 | - [Shareable configuration](docs/extending/shareable-configurations-list.md)
|
| 119 | - Recipes
|
| 120 | - [CI configurations](docs/recipes/README.md)
|
| 121 | - [Git hosted services](docs/recipes/README.md)
|
| 122 | - [Release workflow](docs/recipes/README.md)
|
| 123 | - [Package managers and languages](docs/recipes/README.md)
|
| 124 | - Developer guide
|
| 125 | - [JavaScript API](docs/developer-guide/js-api.md)
|
| 126 | - [Plugins development](docs/developer-guide/plugin.md)
|
| 127 | - [Shareable configuration development](docs/developer-guide/shareable-configuration.md)
|
| 128 | - Support
|
| 129 | - [Resources](docs/support/resources.md)
|
| 130 | - [Frequently Asked Questions](docs/support/FAQ.md)
|
| 131 | - [Troubleshooting](docs/support/troubleshooting.md)
|
| 132 | - [Node version requirement](docs/support/node-version.md)
|
| 133 | - [Node Support Policy](docs/support/node-support-policy.md)
|
| 134 |
|
| 135 | ## Get help
|
| 136 |
|
| 137 | - [Stack Overflow](https://stackoverflow.com/questions/tagged/semantic-release)
|
| 138 | - [Spectrum community](https://spectrum.chat/semantic-release)
|
| 139 | - [Twitter](https://twitter.com/SemanticRelease)
|
| 140 |
|
| 141 | ## Badge
|
| 142 |
|
| 143 | Let people know that your package is published using **semantic-release** by including this badge in your readme.
|
| 144 |
|
| 145 | [](https://github.com/semantic-release/semantic-release)
|
| 146 |
|
| 147 | ```md
|
| 148 | [](https://github.com/semantic-release/semantic-release)
|
| 149 | ```
|
| 150 |
|
| 151 | ## Team
|
| 152 |
|
| 153 | | [](https://github.com/boennemann) | [](https://github.com/relekang) | [](https://github.com/jo) | [](https://github.com/gr2m) | [](https://github.com/finnp) | [](https://github.com/pvdlg) | [](https://github.com/christophwitzko) |
|
| 154 | |---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
|
| 155 | | [Stephan Bönnemann](https://github.com/boennemann) | [Rolf Erik Lekang](https://github.com/relekang) | [Johannes Jörg Schmidt](https://github.com/jo) | [Gregor Martynus](https://github.com/gr2m) | [Finn Pauls](https://github.com/finnp) | [Pierre Vanduynslager](https://github.com/pvdlg) | [Christoph Witzko](https://github.com/christophwitzko) |
|
| 156 |
|
| 157 | <p align="center">
|
| 158 | <img alt="Kill all humans" src="media/bender.png">
|
| 159 | </p>
|