Skip to content

Commit 0e43f7f

Browse files
authored
Merge pull request #96 from karthik2804/docs/add_release_process
add release process
2 parents d0c0794 + 904077f commit 0e43f7f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

release-process.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Cutting a new release for the JS SDK
2+
3+
To cut a new release for the sdk, you will need to do the following,
4+
5+
1. Create a new pull request that changes the version number of the cargo.toml of both `spin-js-cli` and `spin-js-engine` crates. Also make sure to update the version number of the number of the `spin-sdk` NPM package in `types/package.json`.
6+
7+
1. Merge PR created in step #1 (Such PRs are still required to get approvals, so make sure you get signoff on the PR).
8+
9+
1. Push the update NPM package to the NPM registry.
10+
11+
1. Update `package.json` in the examples to point at the new NPM package.
12+
13+
2. Create a new tag with a `v` and then the version number.
14+
15+
3. Push the tag upstream to trigger the release action.
16+
- The release build will create the packaged version of the plugins and the checksums and upload to github releases.
17+
- Release notes are auto-generated but edit as needed especially around breaking changes or other notable items.
18+
19+
4. Update `fermyon/spin-plugins` repository with the updated manifest.
20+
21+
At this point, you can just verify that all things are good.

0 commit comments

Comments
 (0)