Skip to content

Commit

Permalink
Nightly Toolchain Note (#675)
Browse files Browse the repository at this point in the history
## Type of change

<!-- (mark with an `X`) -->

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

## Objective

<!--Describe what the purpose of this PR is. For example: what bug
you're fixing or what new feature you're adding-->

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

<!--Explain the changes you've made to each file or major component.
This should help the reviewer understand your changes-->
<!--Also refer to any related changes or PRs in other repositories-->

- **README.md:** Add nightly install instructions

## Before you submit

- Please add **unit tests** where it makes sense to do so
  • Loading branch information
coltonhurst committed Mar 25, 2024
1 parent cb2e1f3 commit 596ce17
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -86,6 +86,9 @@ This project uses customized templates which lives in the `support/openapi-templ
These templates resolves some outstanding issues we've experienced with the rust generator. But we
strive towards modifying the templates as little as possible to ease future upgrades.

Note: If you don't have the nightly toolchain installed, the `build-api.sh` script will install it
for you.

## Tests

Many of the SDK tests are based on encrypted data provided by the other Bitwarden clients. In order
Expand Down
1 change: 1 addition & 0 deletions support/build-api.sh
Expand Up @@ -22,5 +22,6 @@ npx openapi-generator-cli generate \
-t ./support/openapi-template \
--additional-properties=packageVersion=1.0.0

rustup toolchain install nightly
cargo +nightly fmt
npm run prettier

0 comments on commit 596ce17

Please sign in to comment.