19 lines
719 B
Markdown
19 lines
719 B
Markdown
# Ruma xtasks
|
|
|
|
This crate is a helper bin for repetitive tasks during Ruma development, based on [cargo xtask][xtask].
|
|
|
|
To use it, run `cargo xtask [command]` anywhere in the workspace.
|
|
|
|
Some commands need configuration variables. Copy `config.toml.sample` to `config.toml` and fill
|
|
the appropriate fields.
|
|
|
|
## Commands
|
|
|
|
- `release [crate] [version]`: Publish `crate` at given `version`, if applicable<sup>[1](#ref-1)</sup>, create a
|
|
signed tag based on its name and version and create a release on GitHub.
|
|
**Requires all `github` fields in `config.toml`.**
|
|
|
|
<sup><span id="ref-1">1</span></sup> if `crate` is a user-facing crate and `version` is not a pre-release.
|
|
|
|
[xtask]: https://github.com/matklad/cargo-xtask
|