Plugins
Last updated
Last updated
Note: this is already part of semantic-release and does not have to be installed separately
analyzeCommits: Determine the type of release by analyzing commits with
Note: this is already part of semantic-release and does not have to be installed separately
generateNotes: Generate release notes for the commits added since the last release with
Note: this is already part of semantic-release and does not have to be installed separately
verifyConditions: Verify the presence and the validity of the GitHub authentication and release configuration
publish: Publish a
success: Add a comment to GitHub issues and pull requests resolved in the release
fail: Open a GitHub issue when a release fails
Note: this is already part of semantic-release and does not have to be installed separately
verifyConditions: Verify the presence and the validity of the npm authentication and release configuration
prepare: Update the package.json version and create the npm package tarball
publish: Publish the package on the npm registry
verifyConditions: Verify the presence and the validity of the GitLab authentication and release configuration
publish: Publish a
verifyConditions: Verify the presence and the validity of the Git authentication and release configuration
prepare: Push a release commit and tag, including configurable files
verifyConditions: Verify the presence and the validity of the configuration
prepare: Create or update the changelog file in the local project repository
verifyConditions: Execute a shell command to verify if the release should happen
analyzeCommits: Execute a shell command to determine the type of release
verifyRelease: Execute a shell command to verifying a release that was determined before and is about to be published
generateNotes: Execute a shell command to generate the release note
prepare: Execute a shell command to prepare the release
publish: Execute a shell command to publish the release
success: Execute a shell command to notify of a new release
fail: Execute a shell command to notify of a failed release
verifyConditions: Verify the presence of the ATOM_ACCESS_TOKEN environment variable and the CLI
prepare: Update the package.json version with
publish: Publish the
verifyConditions: Verify that the environment variable SLACK_WEBHOOK has been defined.
success: Publish a message about the success to a slack channel.
fail: Optionally publish a message about failure to a slack channel.
verifyConditions: Verify that all needed configuration is present and login to the Docker registry.
publish: Tag the image specified by name with the new version, push it to Docker Hub and update the latest tag
verifyConditions: Verify that all needed configuration is present and login to the configured docker registry.
publish: Tag the image specified by name with the new version and channel and push it to the configured docker registry.
addChannel: Updates a release published on one channel with the destinations channel tag and pushes to the registry i.e.: next to latest.
verifyConditions: Verify that all needed configuration is present and login to the Docker registry
publish: Tag the image specified by name with the new version, push it to Docker Hub and update the latest tag
verifyConditions: Verify the presence and the validity of the "VS Code extension" authentication and release configuration
prepare: Create a .vsix for distribution
publish: Publish the package to the Visual Studio Code marketplace
verifyConditions: Check the dependencies format against a regexp before a release
verifyConditions: Verify the presence of the authentication (set via environment variables)
prepare: Write the correct version to the manifest.json and creates a zip file of the whole dist folder
publish: Uploads the generated zip file to the webstore, and publish the item
verifyConditions: Verify that all required options are present and authentication is set via environment variables
prepare: Write the correct version to the manifest.json
publish: Creates an unsigned .xpi file, and submits it to the Mozilla Add On store for signing. Once the package is signed, downloads the signed .xpi to a local directory
generateNotes: Generate release notes with Gerrit reviews URL
verifyConditions: Verify Expo manifest(s) are readable and valid.
prepare: Update version, ios build number and android version code in the Expo manifest(s).
verifyConditions: Verifies that the pom.xml file and other files exist and are setup to allow releases
verifyRelease: Checks and warns (does not error by default) if the version numbers found on maven central and within the Git project differ by quite a bit
prepare: Changes the version number in the pom.xml (or all pom.xml files in maven projects with multiple pom.xml files) and optionally creates a commit with this version number and pushes it to master
publish: Runs mvn deploy to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch
verifyConditions: Verifies that the mvn command exists.
prepare: Changes version number in pom.xml and optionally in all child modules.
publish: Runs one of the mvn targets deploy, package jib:build or deploy jib:build.
success: Optionally sets new snapshot version and commits it.
prepare: Stores the version number as an Azure DevOps pipeline variable available to downstream steps on the job
verifyConditions: Verify that project has a Gradle wrapper script, and build.gradle contains a task to publish artifacts.
prepare: Changes the version number in the gradle.properties
publish: Triggers Gradle to publish artifacts.
verifyConditions: Verify the presence of the CIRCLECI_API_TOKEN environment variable, orbName option, and the circleci CLI.
publish: Publish the CircleCI orb.
verifyConditions: Verify the presence of the auth token set via environment variables.
publish: Pushes commit to the documentation branch.
verifyConditions: Verify the presence and the validity of the GitHub authentication and other configuration.
publish: Create a branch to upload all assets and create the pull request on the base branch on GitHub.
verifyConditions: Checks the project.clj is syntactically valid.
prepare: Update the project.clj version and package the output jar file.
publish: Publish the jar (and generated Maven metadata) to a maven repository (or clojars).
verifyConditions: Verify the presence and the validity of the authentication and the assets option configuration.
publish: Publish a Gitea release, optionally uploading file assets.
addChannel: Update a Gitea release's pre-release field.
prepare: Replace version strings in files using regex and glob.
verifyConditions: Locate and validate a .gemspec file, locate and validate a lib/**/version.rb file, verify the presence of the GEM_HOST_API_KEY environment variable, and create a credentials file with the API key.
verifyConditions: Validates configuration.
publish: Deprecates old versions, based on the declaration of supported versions in the config.
Note: this is a thin wrapper around the built-in npm plugin that can target multiple registries
verifyConditions: Verify the presence and the validity of the npm authentication and release configuration for multiple registries
prepare: Update the package.json version and create the npm package tarball
publish: Publish the package on the npm registry for multiple registries
verifyConditions: Verify the presence of a license file
prepare: Update the license file based on its type
verifyConditions: Verify the environment variable PYPI_TOKEN and installation of build tools
prepare: Update the version in setup.cfg and create the distribution packages
publish: Publish the python package to a repository (default: pypi)
verifyConditions: Verify the presence and validity of pyproject.toml file.
prepare: Update the version in pyproject.toml.
verifyConditions: Validate configuration, get AWS CodeArtifact authentication and repository, validate publishConfig or .npmrc (if they exist), then pass the configuration to the associated plugins.
verifyConditions: Validate configuration and verify TELEGRAM_BOT_ID and TELEGRAM_BOT_TOKEN
success: Publish a message about the successful release to a telegram chat
fail: publish a message about failure to a telegram chat
verifyConditions: Validate configuration and verify HEROKU_API_KEY
prepare: Update the package.json version and create release tarball
publish: Publish version to heroku
verifyConditions: Verify that the webhook is setup and release-notes-generator is present.
verifyConditions: Verify github tokens are present and valid.
verifyRelease: Display information regarding the matching github milestone.
verifyConditions: Validate configuration and verify TELEGRAM_BOT_TOKEN and package name
success: Publish a success message to certain telegram chats
fail: Publish a fail message to certain telegram chats
publish: Automatically mark old versions as deprecated.
verifyConditions: Verify plugin configuration and login to Helm registry
prepare: Package Helm chart to local folder
publish: Publish Helm chart to OCI registry
verifyConditions Verifies that all required options are set.
prepare Creates a JetBrains Space Deployment Target if it does not yet exist.
publish Starts a JetBrains Space Deployment.
success Marks the JetBrains Space Deployment as completed.
fail Marks the JetBrains Space Deployment as failed.
verifyConditions Validate configuration.
prepare Version native iOS and Android files.
verifyConditions Validate configuration, Cargo.toml, and local cargo executable. Also, logs in into crates.io.
prepare Write the new version number into Cargo.toml file and perform cargo check if configured.
publish Publish the Rust crate to crates.io
verifyConditions Verified that required credentials are provided and API is accessible
publish add a release tag to Coralogix
verifyConditions: Validate the config options.
generateNotes: Generate the release notes with links to JIRA issues.
success Create major version tag, for example v1.
Note: this is an alternative to the default @semantic-release/npm plugin and adds support for monorepos.
verifyConditions Verify Yarn 2 or higher is installed, verify the presence of a NPM auth token (either in an environment variable or a .yarnrc.yml file) and verify the authentication method is valid.
prepare Update the package.json version and create the package tarball.
addChannel Add a tag for the release.
publish Publish to the npm registry.
verifyConditions: Verify the presence of the pub.dev authentication and release configuration
prepare: Update the pubspec.yaml version
publish: Publish the package onto the pub.dev registry
verifyConditions: Verify the environment variable HACKAGE_TOKEN
prepare: Update the version of .cabal file and create the distribution package (.tar)
publish: Publish the release candidate to the specified repository in Hackage
verifyConditions Verify configuration options and existance of GitHub token.
analyzeCommits Determine the type of release by analyzing merged GitHub pull requests and their labels.
verifyConditions: Verify that all needed configuration is present and login to the Docker registry.
to add your plugin to the list.
(alternative version)
prepare: Update the version in the lib/**/version.rb version file and the gem.
publish: to the gem server.
Automatically update dates and more in your license file for new releases.
success: Send a message about the new release and its notes to a webhook.
prepare: Update the version number in any file that matches the defined .
generateNotes Generates release notes using .
analyzeCommits Analyzing commit messages by .
publish: Build a container image using and (optionally) push it to a Docker registry.