Skip to content

Commit c77fb7d

Browse files
committed
Update documentation
1 parent 0f1cabd commit c77fb7d

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/docs/developers/guides/rpc_test_snapshot.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ A test snapshot generated in the previous step is in JSON format, for easier ins
3333

3434
### Run the test snapshots in unit tests
3535

36-
- upload the test snapshots (`.zst` format is recommended) to the Digital Ocean space `forest-snapshots/rpc_test`
37-
- include the file names in `src/tool/subcommands/api_cmd/test_snapshots.txt`
38-
- run `cargo test --lib -- --test rpc_regression_tests --nocapture`
36+
1. Manual Method
37+
- Upload the test snapshots (`.zst` format is recommended) to the Digital Ocean space `forest-snapshots/rpc_test`
38+
- Include the file names in `src/tool/subcommands/api_cmd/test_snapshots.txt`
39+
- Run the tests:
40+
```
41+
cargo test --lib -- --test rpc_regression_tests --nocapture
42+
```
43+
44+
2. Using the Script
45+
- (One-time setup) Configure your DigitalOcean credentials:
46+
```
47+
s3cmd --configure
48+
```
49+
- Compress, upload the snapshots, update `test_snapshots.txt` and run the tests:
50+
```
51+
scripts/tests/upload_rcpsnaps.sh /var/tmp/rpc-snapshots
52+
```
53+

0 commit comments

Comments
 (0)