about summary refs log tree commit diff
path: root/lib
diff options
context:
space:
mode:
authorDavid Lattimore <dvdlttmr@gmail.com>2023-06-21 11:23:07 +1000
committerDavid Lattimore <dvdlttmr@gmail.com>2023-06-21 16:10:17 +1000
commit5c8d1a46b5637d56760afff28b91519d50dc99fd (patch)
tree10b091e0f685536c35b6bb2c4b6c1a2d1e0fa1ed /lib
parent2d64a0aa6eddc8b72f4a7c7ac517ca21ef21c87a (diff)
downloadrust-5c8d1a46b5637d56760afff28b91519d50dc99fd.tar.gz
rust-5c8d1a46b5637d56760afff28b91519d50dc99fd.zip
Use lib crates from crates.io
See lib/README.md for justification
Diffstat (limited to 'lib')
-rw-r--r--lib/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md
index ed55e31d6bb..d420eeb9605 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -3,3 +3,12 @@
 Crates in this directory are published to [crates.io](https://crates.io) and obey semver.
 
 They _could_ live in a separate repo, but we want to experiment with a monorepo setup.
+
+We use these crates from crates.io, not the local copies because we want to ensure that
+rust-analyzer works with the versions that are published. This means if you add a new API to these
+crates, you need to release a new version to crates.io before you can use that API in rust-analyzer.
+
+To release new versions of these packages, change their version in Cargo.toml. Once your PR is merged into master a workflow will automatically publish the new version to crates.io.
+
+While prototyping, the local versions can be used by uncommenting the relevant lines in the
+`[patch.'crates-io']` section in Cargo.toml