All Projects β†’ semantic-release β†’ Semantic Release

semantic-release / Semantic Release

Licence: mit
πŸ“¦πŸš€ Fully automated version management and package publishing

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Semantic Release

Cli
πŸ†‘πŸ“ Setup automated semver compliant package publishing
Stars: ✭ 272 (-98.11%)
Mutual labels:  automation, version, publish, package, release, changelog, semver
Release It
πŸš€ Automate versioning and package publishing
Stars: ✭ 4,773 (-66.77%)
Mutual labels:  automation, publish, release, release-automation, changelog, semver
git
πŸ”€ semantic-release plugin to commit release assets to the project's git repository
Stars: ✭ 235 (-98.36%)
Mutual labels:  changelog, version, release, semantic-release
exec
🐚 semantic-release plugin to execute custom shell commands
Stars: ✭ 94 (-99.35%)
Mutual labels:  version, release, semantic-release, publish
Bump
Bump updates the project's version, updates/creates the changelog, makes the bump commit, tags the bump commit and makes the release to GitHub. Opinionated but configurable.
Stars: ✭ 327 (-97.72%)
Mutual labels:  automation, version, release, changelog
perfekt
Release, changelog and version your packages with perfe(k)t πŸ‘Œ ease!
Stars: ✭ 15 (-99.9%)
Mutual labels:  changelog, semver, version, release
Npm
🚒 semantic-release plugin to publish a npm package
Stars: ✭ 103 (-99.28%)
Mutual labels:  version, publish, release
Git Changelog Lib
Library for parsing and generating a changelog, or releasenotes, from a GIT repository
Stars: ✭ 117 (-99.19%)
Mutual labels:  release, release-automation, changelog
Release Notes Generator
πŸ“‹ semantic-release plugin to generate changelog content with conventional-changelog
Stars: ✭ 123 (-99.14%)
Mutual labels:  publish, release, changelog
version-check
An action that allows you to check whether your npm package version has been updated
Stars: ✭ 65 (-99.55%)
Mutual labels:  package, semver, version
Releaser Tools
Create a GitHub/GitLab/etc. release using a project's commit messages and metadata.
Stars: ✭ 283 (-98.03%)
Mutual labels:  release, release-automation, changelog
Gh Release
Create a github release for a node package.
Stars: ✭ 132 (-99.08%)
Mutual labels:  release, changelog, semver
Python Semver
Python package to work with Semantic Versioning (http://semver.org/)
Stars: ✭ 264 (-98.16%)
Mutual labels:  version, release, semver
change
A simple tool that automates generating and updating a changelog
Stars: ✭ 47 (-99.67%)
Mutual labels:  changelog, semver, release
generate-changelog
generates changelog from git based on jira tickets
Stars: ✭ 18 (-99.87%)
Mutual labels:  changelog, release, release-automation
Commit Analyzer
πŸ’‘ semantic-release plugin to analyze commits with conventional-changelog
Stars: ✭ 146 (-98.98%)
Mutual labels:  publish, release, changelog
Shipjs
Take control of what is going to be your next release.
Stars: ✭ 668 (-95.35%)
Mutual labels:  automation, release, semver
Changelog
πŸ“˜ semantic-release plugin to create or update a changelog file
Stars: ✭ 142 (-99.01%)
Mutual labels:  version, release, changelog
Github
semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues
Stars: ✭ 159 (-98.89%)
Mutual labels:  version, publish, release
Standard Version
πŸ† Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
Stars: ✭ 5,806 (-59.58%)
Mutual labels:  version, release, changelog

πŸ“¦πŸš€ semantic-release

Fully automated version management and package publishing

Join the community on GitHub Discussions Build states 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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].