chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: Make note of cargo xtask in CONTRIBUTING.md and how_to_release.md

Browse Source
This commit is contained in:
Jonas Platte 2021-04-17 19:01:17 +02:00
parent 233b473041
commit 5d7d7cf187
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
2 changed files with 23 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -135,9 +135,14 @@ Also, `serde_json::Value` should be imported as `JsonValue`.
Use `rustfmt` to format your code and `clippy` to lint your code¹. Before
committing your changes, go ahead and run `cargo fmt` and `cargo clippy`² on the
repository to make sure that the formatting and linting checks pass in CI. Note
that `clippy` warnings are reported as errors in CI builds, so make sure to
handle those before comitting as well.
repository to make sure that the formatting and linting checks pass in CI.
To run all of the tests the same way CI does, run `cargo xtask ci`. This will
run some checks for Rust stable, Rust nightly, and our minimum supported Rust
version. It requires `rustup` to be installed and the toolchains for those three
versions to be set up (in case of a toolchain issue, `rustup` will tell you what
to do though). There are also `cargo xtask ci stable|nightly|msrv` subcommands
for only running one of the CI jobs.
¹ To install the tools, run `rustup component add rustfmt clippy`.
² If you modified feature-gated code (`#[cfg(feature = "something")]`), you will

55
contrib/how_to_release.md
View File

@ -1,50 +1,25 @@
# How to release new versions of the Ruma crates
## General
* `ruma-identifiers-validation` and the `-macros` crates don't get their own
release commit or tag since they are internal packages.
* Macro crates are versioned identically to their "parent" crate and need to be
released before the parent crate.
* `ruma-identifiers-validation` is released before `ruma-identifiers-macros`
and `ruma-identifiers`.
## Creating a release commit
*To be automated in the future, see https://github.com/ruma/ruma/issues/452.*
Update `Cargo.toml` of the relevant package, and update the dependency on this
package in other crates in the workspace (if applicable):
* When doing a prerelease (e.g. `0.10.0-beta.1`), depend on it with an exact
version requirement (`version = "=0.10.0-beta.1`)
* Macro crate dependencies always use an exact version requirement, even for
final releases.
* Otherwise, use `version = "x.y.z"`.
Update the `CHANGELOG.md` of the relevant package.
* If there is already a section for the version to be released, remove the
`(unreleased)` from its title.
* Otherwise, change the `[unreleased]` section title to the version being
released.
Finally, commit these changes as `Release {crate} {version}`.
## Publishing to crates.io and creating a release tag
For `ruma-identifiers-validation` or one of the macro crates, only publish them
to crates.io without creating a release tag:
Releasing one of the crates is very simple since it is entirely automated.
The only thing you have to do is to run
```
cargo publish
cargo xtask release {crate} {version}
```
For all others, the corresponding `xtask` command does both:
The `xtask` script will then take care of
```
cargo xtask release {crate}
```
* updating all affected `Cargo.toml`s
* adding a new version header to the changelog
* collecting the changes from the changelog
* creating a release commit
* publishing the new release to [crates.io](https://crates.io/)
* creating a release tag and GitHub release if applicable
If some part of `cargo xtask release` fails, for example because of internet
connectivity issues, you can run the exact same command again to retry. Steps
that were already completed will be detected and an option to continue with
the next step will be given.
## Dependencies