Skip to content

Commit f140ab3

Browse files
authored
Add upgrade documentation for the build refactor
1 parent c79c579 commit f140ab3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

UPGRADE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
This document is intended to simplify upgrading to newer versions by extending the changelog.
44

5+
## 0.36 -> 0.37
6+
7+
`rustler_mix` will now require a workspace with the same root as the Elixir
8+
package with all relevant crates included as workspace members. If the package
9+
previously had a crate at `native/my_crate`, a `Cargo.toml` with the following
10+
content should be added at the root:
11+
```toml
12+
[workspace]
13+
resolver = "3"
14+
members = ["native/my_crate"]
15+
```
16+
17+
The `/target` directory should also be added to the root's `.gitignore` file.
18+
19+
More information on workspaces can be found in the Rust documentation at
20+
https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html.
21+
522
## 0.34 -> 0.35
623

724
`rustler_sys` as a standalone library has been replaced by an embedded

0 commit comments

Comments
 (0)