Add some docs about how to release new versions

This commit is contained in:
Jonas Platte 2021-01-02 14:20:30 +01:00
parent e77de978cf
commit 3c78d35b7a
No known key found for this signature in database
GPG key ID: 7D261D771D915378
2 changed files with 24 additions and 0 deletions

24
contrib/how_to_release.md Normal file
View file

@ -0,0 +1,24 @@
# How to release new versions of the Ruma crates
## General
* When releasing a pre-release version, make sure other crates are updated to
depend on it, with an exact version requirement (`=x.y.z-tag`)
* When releasing a regular version, make sure other crates are updated to depend
on it, with a regular (same as caret / `^`) version requirement (`x.y.z`)
* Macro crates are versioned identically to their "parent" crate and are exempt
from the rule above: Dependencies from the parent crate to the macro crate
(for re-exporting) should always use exact version requirements. Whenever a
crate with an associated macro crate should get a new release, release a new
version of the macro crate with the same number first, even if there were no
changes in the macro code.
## Dependencies
Dependencies obviously need to be released before dependents. Also, a breaking
change release in a dependency should usually be followed by a new release of
all dependents.
![crate dependencies](./workspace_deps.png)
<small><code>cargo depgraph --all-features --exclude syn,quote,js_int,trybuild,criterion,proc-macro2,serde,http,form_urlencoded,serde_json,proc-macro-crate,rand,either,ring,base64,itoa,untrusted,futures-util,hyper,hyper-tls,hyper-rustls,thiserror,paste,assign,futures-core,maplit,percent-encoding --dedup-transitive-deps | dot -Tpng</code></small>

BIN
contrib/workspace_deps.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB