Skip to content

Commit 8735c72

Browse files
committed
Update PUBLISH.md documentation
1 parent 917e714 commit 8735c72

File tree

4 files changed

+9953
-14635
lines changed

4 files changed

+9953
-14635
lines changed

PUBLISH.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
## Publish instructions
22

3-
Replace `$VERSION` with the desired new version (e.g. `0.7.0`):
3+
The SDK NPM package contains binaries which work on both the latest `mainnet` and `testnet` releases.
4+
5+
Set `SDK_TAG` to the desired new version (e.g. `v0.7.0`):
6+
7+
When creating a `testnet` release:
8+
- download the latest `sdk` and `wasm` `mainnet` release to be packaged from https://github.com/ProvableHQ/sdk/releases
9+
- `git checkout testnet`
10+
- set `PREVIOUS_RELEASE=testnet`
11+
12+
When creating a `mainnet` release:
13+
- download the latest `sdk` and `wasm` `testnet` release to be packaged from https://github.com/ProvableHQ/sdk/releases
14+
- `git checkout mainnet`
15+
- set `PREVIOUS_RELEASE=mainnet`
16+
417

518
```bash
619
yarn build:all
20+
mv latest_release/wasm/dist/${PREVIOUS_RELEASE} wasm/dist/${PREVIOUS_RELEASE}
21+
mv latest_release/sdk/dist/${PREVIOUS_RELEASE} sdk/dist/${PREVIOUS_RELEASE}
722
npm login
8-
cd wasm && npm publish --access public
9-
cd ../sdk && npm publish --access public
10-
cd ../create-leo-app & npm publish --access public
11-
git tag vX.X.X
12-
git push origin vX.X.X
23+
npm deploy:wasm
24+
npm deploy:sdk
25+
npm deploy:create-leo-app
26+
git tag ${SDK_TAG}
27+
git push origin ${SDK_TAG}
1328
```

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ several TypeScript & JavaScript libraries which provide the following functional
1919

2020
All of this functionality is demonstrated on [Provable.tools](https://provable.tools).
2121

22+
You will need `Node` version `22` or higher.
2223

2324
The Provable SDK is divided into three TypeScript/JavaScript packages:
2425

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,8 @@
3636
"devDependencies": {
3737
"prettier": "3.4.2",
3838
"wasm-pack": "^0.13.1"
39+
},
40+
"dependencies": {
41+
"rimraf": "^6.1.2"
3942
}
4043
}

0 commit comments

Comments
 (0)