Commit Graph

2 Commits

Author SHA1 Message Date
Kevin Liu
de2de896f5 chore: specify path dependencies for workspace crates (#568)
## Motivation

Intra-workspace dependencies can go out of sync if only referencing
crates.io, where changing one crate locally and testing the whole
library will result in errors stemming from two different versions of
the same trait etc. This is hard to keep track of and makes development
more difficult than it needs to be. 

## Solution

Afaik it's common practice to specify both a version and a path as per
[the cargo docs][1]. This is what tokio does with its subcrates too.

[1]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/specifying-dependencies.md#multiple-locations.
2020-02-07 10:54:49 -08:00
Eliza Weisman
69fc365e8b meta: add releasing docs and automation (#141)
This branch updates CONTRIBUTING.md to document how to release
a new version of a Tracing crate, and adds the `publish` shell script
from the `tokio-rs/tokio` repo to aid in the release process.

I've also updated references in CONTRIBUTING.md to refer to Tracing
rather than Tokio Trace.

* docs: add release section to CONTRIBUTING.md
* add publish script
* docs: remove references to tokio-trace/nursery

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2019-07-03 12:00:34 -07:00