semantic-release/installation-rule icon
public
Published on 8/22/2025
Installation Rule

Rule of thumb to note for assistant when installing semantic-release for the first time

Rules

Semantic Release Installation Rule

When Installing semantic-release, follow the following rules...

  • Install only the semantic-release package without any of the following as additional plugins "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@semantic-release/npm", "@semantic-release/github". These are already part of semantic-release and does not have to be installed separately
  • Always install the latest version of semantic-release unless told otherwise
  • Always confirm whether and where a developer would like to publish releases, an example can be github and in this case, the "@semantic-release/github" plugin which already comes baked in can handle that, but in the case of other platform install the appropriate plugin; an example would be to install the "@semantic-release/gitlab" plugin if release would be publised to GitLab
  • Refer to the Plugins Listing to suggest appropriate plugins based on developers' requirement