Add scarb update docs (#830)

commit-id:886a473a
software-mansion · Oct 27, 2023 · 7eb2819 · 7eb2819
1 parent c77101e
commit 7eb2819
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ Scarb is under active development! Expect a lot of new features to appear soon!
 - [x] GitHub action
 - [x] Workspaces
 - [x] Nightlies
+- [x] `Scarb.lock`
+- [x] `scarb update`
 - [ ] Standardized `test` target 🏗️
-- [ ] `Scarb.lock` 🏗️
 - [ ] Package registry 🏗️
 - [ ] PubGrub implementation for version resolution
-- [ ] `scarb update`
 - [ ] Dynamic loading of custom Cairo compiler plugins as Scarb packages
 - [ ] Dynamic loading of custom targets aka code generators
 - [ ] `scarb check`

diff --git a/website/docs/cheatsheet.md b/website/docs/cheatsheet.md
@@ -123,3 +123,9 @@ Check formatting in CI:
 ```shell
 scarb fmt -c
 ```
+
+## Updating locked dependencies
+
+```shell
+scarb update
+```
diff --git a/website/docs/reference/lockfile.md b/website/docs/reference/lockfile.md
@@ -79,7 +79,6 @@ version = "0.1.0"
 [dependencies]
 alexandria_math = { git = "https://github.com/keep-starknet-strange/alexandria.git" }
 alexandria_data_structures = { git = "https://github.com/keep-starknet-strange/alexandria.git" }
-
 ```
 
 The resulting lockfile will look like this:
@@ -109,3 +108,10 @@ dependencies = [
  "alexandria_math",
 ]
 ```
+
+## Updating locked versions
+
+To update all versions locked by the lockfile, run `scarb update` command.
+This will perform project resolution ignoring the existing lockfile, then write out a new `Scarb.lock`
+with the new version information.
+Note that the `Scarb.toml` manifest file will not be changed, and all version requirements from it will be preserved.