Automatically publish your Rust projects to Github releases.
You can install cargo-hublish using cargo itself with the following one-liner
cargo install cargo-hublish
I like to write tools, specifically CLI tools. Publishing those tools to Github is a great way to distribute the project. However creating Github releases is fairly tedious so I decided to automate it using metadata from the Cargo.toml
I'm always happy to accept pull requests for any features you would like to see added, a few I personally would like to see added are:
If you're not sure if your feature is a good fit or not, just submit a Github issue asking for comments before you start working on it!
As always follow the Rust Code of Conduct, not only is it the nice thing to do it's one of the reasons I personally get so excited about Rust.
If something you add isn't covered by an existing integration test, please please please write one for your thing.
Please submit all pull requests to the develop branch.
Just like any Rust project you can simply build with
cargo build however I've included a make file which adds some niceties for performing certain commands. Specifically when running tests you should always use
make test since it will clean up and regenerate the cargo project used for integration testing.
Publish Rust projects to Github Releases Usage: cargo hublish [options] Options: -h, --help Show this help message. -n, --name NAME Name of the release. Defaults to package name + version number as defined in Cargo.toml. Example: cargo-hublish v0.1.0 -t, --tag TAG_NAME Name of the git tag for the release, if not set defaults to version number as defined in Cargo.toml. -c, --commit COMMIT SHA of the commit the tag should point to, defaults to HEAD of master -f, --file FILE A file which contains the markdown for the body (description) of the release -m, --message MESSAGE The body of the release (description) -d, --draft Set whether this is a draft release defaults to false -p, --prerelease Set whether this is a prerelease defaults to false --url URL URL for the github API request. cargo-hublish attempts to find this based on the origin url of the git repo. If you're using a different remote such as 'github' then use the --remote flag to set that name, otherwise set the full api url with this flag. -r, --remote REMOTE Remote name to use when generating API endpoint. Defaults to origin. -u, --username USERNAME Your github username. If not provided you will be prompted. -p, --password PASSWORD Your github password. If not provided you will be prompted.