Add instructions on publishing a new SDK version. #53
Conversation
|
👋 ro-tex, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
| @@ -0,0 +1,21 @@ | |||
| # Instructions for publishing a new SDK version | |||
There was a problem hiding this comment.
by publishing do we mean on GH or on a package distribution system? worth clarifying as we have learned from ccip-contracts etc that gh tagged versions may not map to NPM release versions etc as there may be github tagged versions that are not "ready" for NPM release.
Please can you update these instructions to distinguish between process for gh tagging vs release tagging.
There was a problem hiding this comment.
That's a good point. I added some clarifications, so people would know what to expect.
| release notes. | ||
|
|
||
| ## TypeScript | ||
|
|
There was a problem hiding this comment.
TS/NPM released also need the main branch to be tagged right?
There was a problem hiding this comment.
Tagging main sounds like a good idea but it's not required - if you look at SDK v1.2.0, you can see it on NPM but there is no main tag for it.
If we decide to change the process and make that tag a requirement, then this doc will have to change but that's a separate conversation. My only goal with this PR is to describe the current release process, so people don't need to rely on word of mouth in order to get unblocked.
2 participants
No description provided.