From c8dd6524e8b415cd0098a09096d5a70ad7b7827e Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Mon, 8 Apr 2019 07:55:09 -0700 Subject: [PATCH] Add instructions for publishing --- PUBLISHING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 PUBLISHING.md diff --git a/PUBLISHING.md b/PUBLISHING.md new file mode 100644 index 0000000..ad100de --- /dev/null +++ b/PUBLISHING.md @@ -0,0 +1,17 @@ +# Publishing to crates.io + +Publishing `compiler-builtins` to crates.io takes a few steps unfortunately. +It's not great, but it works for now. PRs to improve this process would be +greatly appreciated! + +1. Make sure you've got a clean working tree and it's updated with the latest + changes on `master` +2. Edit `Cargo.toml` to bump the version number +3. Commit this change +4. Run `git tag` to create a tag for this version +5. Delete the `libm/Cargo.toml` file +6. Comment out the `[dev-dependencies]` section of `Cargo.toml` +7. Run `cargo +nightly publish --allow-dirty` +8. Push the tag +9. Push the commit +10. Undo changes to `Cargo.toml` and the `libm` submodule