You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2018/11/08 22:59:20 UTC
[arrow] branch master updated: ARROW-3601: [Rust] Add instructions
for publishing to crates.io
This is an automated email from the ASF dual-hosted git repository.
wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new dccec7a ARROW-3601: [Rust] Add instructions for publishing to crates.io
dccec7a is described below
commit dccec7af96dec2b09359938fc39037eaaef96f95
Author: Andy Grove <an...@gmail.com>
AuthorDate: Thu Nov 8 17:59:13 2018 -0500
ARROW-3601: [Rust] Add instructions for publishing to crates.io
Author: Andy Grove <an...@gmail.com>
Author: Wes McKinney <we...@apache.org>
Closes #2823 from andygrove/ARROW-3601 and squashes the following commits:
5e67eb6cb <Wes McKinney> Slight tweaks, formatting
062a338e4 <Andy Grove> fix typo
5e99cff89 <Andy Grove> fix typo
eb8c39296 <Andy Grove> Add instructions for publishing to crates.io
---
rust/README.md | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/rust/README.md b/rust/README.md
index e3686fd..5f545aa 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -63,3 +63,34 @@ cargo run --example array_from_builder
```bash
cargo test
```
+
+# Publishing to crates.io
+
+An Arrow committer can publish this crate after an official project release has
+been made to crates.io using the following instructions.
+
+Follow [these
+instructions](https://doc.rust-lang.org/cargo/reference/publishing.html) to
+create an account and login to crates.io before asking to be added as an owner
+of the [arrow crate](https://crates.io/crates/arrow).
+
+Checkout the tag for the version to be releases. For example:
+
+```bash
+git checkout apache-arrow-0.11.0
+```
+
+If the Cargo.toml in this tag already contains `version = "0.11.0"` (as it
+should) then the crate can be published with the following command:
+
+```bash
+cargo publish
+```
+
+If the Cargo.toml does not have the correct version then it will be necessary
+to modify it manually. Since there is now a modified file locally that is not
+committed to github it will be necessary to use the following command.
+
+```bash
+cargo publish --allow-dirty
+```