-
Notifications
You must be signed in to change notification settings - Fork 10
Add instructions on publishing a new SDK version. #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ro-tex
wants to merge
6
commits into
main
Choose a base branch
from
chore/publish_runbook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b26118d
Add instructions on publishing a new SDK version.
ro-tex 49cfc8b
Update the Rust bit.
ro-tex 0ee8d59
Merge branch 'main' into chore/publish_runbook
ro-tex 998eee3
Address PR comments.
ro-tex 24afdcc
Merge branch 'main' into chore/publish_runbook
ro-tex 81be90a
Update PUBLISH.md.
ro-tex File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Instructions for publishing a new SDK version | ||
|
|
||
| What this guide covers is how to publish a new SDK package on a package distribution network (where that applies), e.g. | ||
| [NPM](https://www.npmjs.com/package/@chainlink/data-streams-sdk) for TypeScript | ||
| or [crates.io](https://crates.io/crates/chainlink-data-streams-report) for Rust. As Go doesn't use a package system like | ||
| that, the release process is limited to tagging a commit and creating a GitHub release. | ||
|
|
||
| ## Go | ||
|
|
||
| 1. Tag a `main` commit with `go/vX.Y.X`. This is enough for the new version to be considered released. | ||
| 2. Additionally, we can create a new release directly on GitHub. make sure to choose the correct tag, target, and | ||
| previous version/tag. That allows you to use the `Generate release notes` button to get a good starting point of the | ||
| release notes. | ||
|
|
||
| ## TypeScript | ||
|
|
||
ro-tex marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 1. Increment the version in `package.json` to what it should be. | ||
| 2. Run `npm i` in order to update `package-lock.json`. | ||
| 3. Trigger the `Manual NPM Publish for TS SDK` GitHub action. | ||
|
|
||
| ## Rust | ||
|
|
||
| 1. Increment the version in all `Cargo.toml` files: | ||
|
|
||
| rust/crates/report/Cargo.toml: | ||
|
|
||
| ``` | ||
| [package] | ||
| name = "chainlink-data-streams-report" | ||
| - version = "1.1.0" | ||
| + version = "1.2.0" | ||
| ``` | ||
|
|
||
| rust/crates/sdk/Cargo.toml: | ||
|
|
||
| ``` | ||
| [package] | ||
| name = "chainlink-data-streams-sdk" | ||
| - version = "1.1.0" | ||
| + version = "1.2.0" | ||
|
|
||
| ... | ||
|
|
||
| [dependencies] | ||
| - chainlink-data-streams-report = { path = "../report", version = "1.1.0" } | ||
| + chainlink-data-streams-report = { path = "../report", version = "1.2.0" } | ||
| ``` | ||
|
|
||
| 2. Run `cargo build` and `cargo publish --dry-run` in order to update `Cargo.lock`. | ||
| 3. Trigger the `Publish Chainlink Data Streams Report Crate` and `Publish Chainlink Data Streams SDK Crate` GitHub | ||
| actions which will publish the respective crates. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.