plugins-list.md

Plugins list

Default plugins

• @semantic-release/github
  • verifyConditions: Verify the presence and the validity of the GitHub authentication and release configuration
  • publish: Publish a GitHub release
  • success: Add a comment to GitHub issues and pull requests resolved in the release
  • fail: Open a GitHub issue when a release fails
• @semantic-release/npm
  • 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

Official plugins

• @semantic-release/gitlab
  • verifyConditions: Verify the presence and the validity of the GitLab authentication and release configuration
  • publish: Publish a GitLab release
• @semantic-release/git
  • verifyConditions: Verify the presence and the validity of the Git authentication and release configuration
  • prepare: Push a release commit and tag, including configurable files
• @semantic-release/changelog
  • verifyConditions: Verify the presence and the validity of the configuration
  • prepare: Create or update the changelog file in the local project repository
• @semantic-release/exec
  • 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

Community plugins

Open a Pull Request to add your plugin to the list.

• semantic-release-docker Set of semantic-release plugins for publishing a docker image to Docker Hub
  • 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.
• semantic-release-vsce Set of semantic-release plugins for publishing Visual Studio Code extensions to the marketplace
  • verifyConditions Verify the presence and the validity of the vsce authentication and release configuration
  • prepare Create a .vsix for distribution
  • publish Publish the package to the Visual Studio Code marketplace
• semantic-release-verify-deps
  • verifyConditions Check the dependencies format against a regexp before a release
• semantic-release-chrome Set of semantic-release plugins for publishing a Chrome extension 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.