semantic-release

Run semantic-release in the current project

$ npx semantic-release

$ npx semantic-release@[25]

$ npx semantic-release --dry-run

$ npx --package semantic-release --package @semantic-release/exec semantic-release

$ npx semantic-release --branches [main]

$ npx semantic-release --no-ci

$ npx semantic-release --repository-url [https://github.com/user/repo.git]

semantic-release [options]
npx semantic-release [options]

semantic-release automates the entire package release workflow including version determination, changelog generation, and package publishing. It analyzes commits since the last release using conventional commit messages to determine the next semantic version number automatically.
The tool follows the Semantic Versioning specification: fix commits trigger patch releases, feat commits trigger minor releases, and commits with BREAKING CHANGE trigger major releases. It integrates with npm, GitHub, GitLab, and other platforms through a plugin system.
Configuration can be provided via package.json, .releaserc file, release.config.js, or CLI arguments. By default, it releases from main or master branches, with support for pre-release channels (alpha, beta) and maintenance branches.

-d, --dry-run

Run in dry-run mode to preview the pending release without actually publishing. Skips prepare, publish, addChannel, success, and fail steps. Prints the next version and release notes to console.

Run semantic-release in a local environment outside of CI. Useful for testing and debugging.

Define the branches on which releases should happen. Accepts branch names or micromatch glob patterns.

Define the list of plugins to use.

The git repository URL.

The Git tag format used to identify releases. Default: v${version}.

Shareable configuration to extend.

Enable debug output.

Display help information.

semantic-release must run in a CI environment with push access to the repository and publish access to the package registry. The dry-run mode still verifies repository push permissions. Commits must follow conventional commit format for automatic version detection. Plugin options cannot be set via CLI and must be configured in the configuration file.

semantic-release was created by Stephan Boennemann and first released in 2015 to solve the problem of manual, error-prone software releases. It pioneered the concept of fully automated releases based on commit message conventions. The project gained significant adoption in the JavaScript/Node.js ecosystem and influenced similar tools in other languages. It continues active development under the semantic-release organization on GitHub.

npm(1), git(1), conventional-changelog(1)