Skip to content

8-bit-hunters/cargo-semantic-release

Repository files navigation

Cargo Semantic Release

pre-commit.ci status cargo test status Gitmoji

This project aims to create a Cargo plugin that creates semantic releases for Rust projects.

Goals

  • It can be installed as a Cargo plugin
  • Works with Gitmoji commit messages
  • Follows Semantic Versioning guidelines

Installation

If you don't have, install the Rust toolchain.

Install the tool with Cargo with the following command.

cargo install cargo-semantic-release

This will globally install the cargo-semantic-release binary.

Usage

You can run the tool in the directory of your choice via Cargo with the following command.

cargo semantic-release

This will print out the major, minor, patch related changes and the other changes. Also, it will indicate the recommended action for the semantic version.

Library

The utility functions for the binary are available in a library crate.

Links