View Source Semantic Release for Elixir

Mix tasks for installing and running semantic-release (and the adapter plugin semantic-release-hex) in Elixir projects.

⚠️ WARNING

This is a pre-release version. As such, anything may change at any time, the public API should not be considered stable, and using a pinned version is recommended.

Disclaimer: Because semantic-release is written in JavaScript, this package will install Node.js in your _build/ folder upon running.

See the nodelix documentation for more information on how Node.js is installed.

Full documentation can be found at https://hexdocs.pm/semantic_release.

Installation

gpg must be available in your PATH to verify the signature of Node.js releases.

The package can be installed by adding semantic_release to your list of dependencies in mix.exs:

def deps do
  [
    {:semantic_release, "1.0.0-alpha.4", only: :dev, runtime: false}
  ]
end

Configuration

You can list additional npm packages to be passed to the npm install command:

config :semantic_release,
  additional_packages: [
    "@semantic-release/changelog",
    "@semantic-release/git",
  ]

This can also be used to override automatically installed package versions:

config :semantic_release,
  additional_packages: [
    "semantic-release-hex@next",
    "@semantic-release/changelog",
    "@semantic-release/git",
  ]

Versioning

This project follows the principles of Semantic Versioning (SemVer).