Package Health Score

89 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
24.2.0	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
24.1.3	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
23.1.1	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
22.0.12	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
21.1.2	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Key ecosystem project

Weekly Downloads (1,219,801)

GitHub Stars: 21.07K
Forks: 1.69K
Contributors: -

Direct Usage Popularity

The npm package semantic-release receives a total of 1,219,801 downloads a week. As such, we scored semantic-release popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package semantic-release, we found that it has been starred 21,070 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 324
Open PR: 44
Last Release: 2 months ago
Last Commit: 2 days ago

Further analysis of the maintenance status of semantic-release based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that semantic-release demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=20.8.1

Age: 10 years
Dependencies: 29 Direct
Versions: 422
Install Size: 291 kB
Dist-tags: 5
# of Files: 66
Maintainers: 4
TS Typings: Yes

semantic-release has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

📦🚀 semantic-release

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

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

Highlights

Fully automated release
Enforce Semantic Versioning 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 npm dist-tags) based on git merges
Integrate with your continuous integration workflow
Avoid potential errors associated with manual releases
Support any package managers and languages via plugins
Simple and reusable configuration via shareable configurations
Support for npm package provenance that promotes increased supply-chain security via signed attestations on GitHub Actions

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, 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	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:

To host your code in a Git repository
Use a Continuous Integration service that allows you to securely set up credentials
A Git CLI version that meets our version requirement installed in your Continuous Integration environment
A Node.js version that meets our version requirement installed in your Continuous Integration environment

Documentation

Usage
Extending
- Plugins
- Shareable configuration
Recipes
Developer guide
Support

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](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

Alumni


Stephan Bönnemann	Rolf Erik Lekang	Johannes Jörg Schmidt	Finn Pauls	Christoph Witzko

Kill all humans

semantic-release development dependencies

ava c8 clear-module cz-conventional-changelog dockerode file-url fs-extra got js-yaml lockfile-lint ls-engines mockserver-client nock npm-run-all2 p-retry prettier publint sinon stream-buffers tempy testdouble

FAQs

What is semantic-release?

Automated semver compliant package publishing. Visit Snyk Advisor to see a full health score report for semantic-release, including popularity, security, maintenance & community analysis.

Is semantic-release popular?

The npm package semantic-release receives a total of 1,219,801 weekly downloads. As such, semantic-release popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is semantic-release well maintained?

We found that semantic-release demonstrated a healthy version release cadence and project activity. It has a community of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is semantic-release safe to use?

The npm package semantic-release was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 December-2024, at 06:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP