#release #tool #crate

bin+lib releaser

Crate or workspace releasing tool. All crates from workspace will be released on crates.io

41 releases

Uses new Rust 2021

0.10.5 Jan 10, 2023
0.10.4 Dec 24, 2022
0.10.2 Oct 14, 2022
0.8.8 Jun 13, 2022
0.3.1 Mar 30, 2021

#1749 in Command line utilities

Download history 28/week @ 2022-10-07 29/week @ 2022-10-14 11/week @ 2022-10-21 1/week @ 2022-10-28 28/week @ 2022-11-04 18/week @ 2022-11-18 4/week @ 2022-12-02 1/week @ 2022-12-09 39/week @ 2022-12-16 37/week @ 2022-12-23 12/week @ 2022-12-30 28/week @ 2023-01-06 8/week @ 2023-01-13 7/week @ 2023-01-20

55 downloads per month

MIT license

72KB
2K SLoC

crates.io Rust codecov

Installation

Install Rust and then run:

cargo install releaser

Rust workspace release procedure

  1. Read existing version from crate's toml file
  2. Increment version in all workspace's crate's toml files and it's dependencies
  3. Commit all version changes
  4. Create new git tag
  5. Run cargo publish --manifest-path …
  6. Wait some time (20 seconds by default) before publish next crate so as to use new version
  7. Push git tag

Rust crate release procedure

  1. Read existing version from crate's toml file
  2. Increment version in the toml file
  3. Commit all version changes
  4. Create new git tag
  5. Run cargo publish --manifest-path …
  6. Push git tag

Command line syntax:

Crate or workspace releasing tool. All crates from workspace will be released on crates.io

Usage: releaser [COMMAND]

Commands:
  w           Release workspace specified by path
  c           Release single crate specified by path
  b           Create brew package manager Formula (package definition file) to publish it into a tap (MacOS and Linux only)
  s           Create scoop package manager JSON (package definition file) to publish it into bucket (Windows only)
  completion  Generate the autocompletion script for the specified shell
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help information
  -V, --version  Print version information

Releasing workspace

Release workspace specified by path

Usage: releaser w [OPTIONS] <INCR> <PATH>

Arguments:
  <INCR>  Version increment. One of the following: major, minor or patch [possible values: major, minor, patch]
  <PATH>  Sets workspace root path

Options:
  -d, --delay <NUMBER>  Delay in seconds between publish next workflow's crate [default: 20]
  -a, --all             Whether to add option --all-features to cargo publish command
  -n, --noverify        Whether to add option --no-verify to cargo publish command
  -h, --help            Print help information

Releasing simple crate

Release single crate specified by path

Usage: releaser c [OPTIONS] <INCR> <PATH>

Arguments:
  <INCR>  Version increment. One of the following: major, minor or patch [possible values: major, minor, patch]
  <PATH>  Sets crate's root path

Options:
  -a, --all       Whether to add option --all-features to cargo publish command
  -n, --noverify  Whether to add option --no-verify to cargo publish command
  -h, --help      Print help information

Creating brew package manager Formula (package definition file) to publish it into a tap (MacOS and Linux only)

Create brew package manager Formula (package definition file) to publish it into a tap (MacOS and Linux only)

Usage: releaser b [OPTIONS] --crate <PATH> --base <URI>

Options:
  -c, --crate <PATH>     Sets crate's path where Cargo.toml located
  -l, --linux <PATH>     Sets Linux package directory path
  -m, --macos <PATH>     Sets Mac OS package directory path
  -b, --base <URI>       Base URI of downloaded artifacts
  -u, --output [<PATH>]  File path to save result to. If not set result will be written into stdout
  -h, --help             Print help information

Creating scoop package manager JSON definition file to publish it into a bucket (Windows only)

Create scoop package manager JSON (package definition file) to publish it into bucket (Windows only)

Usage: releaser s [OPTIONS] --crate <PATH> --binary <PATH> --exe <FILE> --base <URI>

Options:
  -c, --crate <PATH>     Sets crate's path where Cargo.toml located
  -i, --binary <PATH>    Sets 64-bit binary package directory path
  -e, --exe <FILE>       Sets Windows executable name
  -b, --base <URI>       Base URI of downloaded artifacts
  -u, --output [<PATH>]  File path to save result to. If not set result will be written into stdout
  -h, --help             Print help information

Dependencies

~9–15MB
~311K SLoC