Skip to content

Commit b26118d

Browse files
committed
Add instructions on publishing a new SDK version.
1 parent 37c1126 commit b26118d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

PUBLISH.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Instructions for publishing a new SDK version
2+
3+
## Go
4+
5+
1. Tag a `main` commit with `go/vX.Y.X`. This is enough for the new version to be considered released.
6+
2. Additionally, we can create a new release directly on GitHub. make sure to choose the correct tag, target, and
7+
previous version/tag. That allows you to use the `Generate release notes` button to get a good starting point of the
8+
release notes.
9+
10+
## TypeScript
11+
12+
1. Increment the version in `package.json` to what it should be.
13+
2. Run `npm i` in order to update `package-lock.json`.
14+
3. Trigger the `Manual NPM Publish for TS SDK` GitHub action.
15+
16+
## Rust
17+
18+
1. Increment the version in all `Cargo.toml` files.
19+
2. Run `cargo build` and `cargo publish --dry-run` in order to update `Cargo.lock`.
20+
3. Run the `Publish Chainlink Data Streams SDK Crate` and `Publish Chainlink Data Streams Report Crate` GitHub actions.

0 commit comments

Comments
 (0)