Nightly Toolchain Note

[coltonhurst]

Type of change

- [ ] Bug fix
- [ ] New feature development
- [x] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

Add a note about the required nightly toolchain. Without this people will receive an error when attempting to run the build-api.sh script.

For posterity, the nightly toolchain is required for certain features deemed unsafe. You can find more info here: #512

Code changes

• README.md: Add nightly install instructions

Before you submit

• Please add unit tests where it makes sense to do so

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.61%. Comparing base (67e743f) to head (45fb1b6).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #675   +/-   ##
=======================================
  Coverage   60.61%   60.61%           
=======================================
  Files         170      170           
  Lines       10387    10387           
=======================================
  Hits         6296     6296           
  Misses       4091     4091           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dani-garcia]

LGTM, we can also consider running rustup toolchain install nightly inside the script directly, as it's pretty fast when the nightly toolchain is already installed.

[coltonhurst]

LGTM, we can also consider running rustup toolchain install nightly inside the script directly, as it's pretty fast when the nightly toolchain is already installed.

Fair. Is there a pattern or precedence set in other crates that use nightly commands in scripts? I personally like installing toolchains manually but I'm totally fine either way.

[dani-garcia]

I know cross does at least, when running cross build -p bitwarden-uniffi --release --target=aarch64-linux-android to build the android SDK, it will install the stable-x86_64-unknown-linux-gnu to run the build under docker.

[coltonhurst]

I know cross does at least, when running cross build -p bitwarden-uniffi --release --target=aarch64-linux-android to build the android SDK, it will install the stable-x86_64-unknown-linux-gnu to run the build under docker.

Good point. I have moved it to the script & updated the readme in this commit: 567f1db

[dani-garcia]

The lint CI is failing, you need to run npm run prettier because the readme changes are exceeding the line wrapping