1 unstable release

0.1.0 Jan 2, 2019

#54 in #ease

MIT license

9KB
120 lines

release-me

Create your release with ease!



[documentation] [repository]


Purpose

The main purpose is to publish my lib with more ease.

I want to have one simple command that:

  • Generate a changelog from the last tag to HEAD
  • Create the github release
  • Publish to npm (or crates.io)

Roadmap

  • Use gitmoji-changelog to create the latest release changelog
  • Let the user change its changelog text
  • Publish to github
  • Publish to npm
  • Publish to cargo

Try it

With Docker 🐳!

## set your github token
## - the github token needs to have "repo" privileges
## - you can create a new token here: https://github.com/settings/tokens/new
export GITHUB_TOKEN="your token"

## try it
docker run --rm -e GITHUB_TOKEN=${GITHUB_TOKEN} -v ${PWD}:/repo fabienjuif/release-me /repo --release <your_version>
# ex: docker run --rm -e GITHUB_TOKEN=${GITHUB_TOKEN} -v ${PWD}:/repo fabienjuif/release-me /repo --release

## to see which options you can use:
docker run --rm -e GITHUB_TOKEN=${GITHUB_TOKEN} fabienjuif/release-me --help

With cargo

## install it
cargo install release-me

# maybe you should reset your env here (relaunch your terminal or type `zsh` (or `bash`))

## set your github token
## - the github token needs to have "repo" privileges
## - you can create a new token here: https://github.com/settings/tokens/new
export GITHUB_TOKEN="your token"

## try it
release-me . --release #<your_version>
# ex: release-me . --release v0.1.0

## to see which options you can use:
release-me --help

Commands

This project use a Makefile, here are the main targets:

  • package: build the docker image
  • ci: build the project (dev mode) and check clippy and rustfmt

You can still use cargo if you want to, eg building the release version with: cargo build --release

Dependencies

~33MB
~719K SLoC