From f2019ea67e3c80242e11906a7f76739dd53e5a54 Mon Sep 17 00:00:00 2001 From: samfairbairn Date: Tue, 9 Jul 2024 20:01:30 +0800 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2a5edba..08808a0 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,16 @@ NEXT_PUBLIC_STORY_PROTOCOL_X_API_KEY="l0YkL0VIBK6-nfb7SGake4s3ctg=" NEXT_PUBLIC_SIMPLE_HASH_API_KEY="SIMPLEHASH_API_KEY_HERE" ``` +## Releasing New Versions + +Before publishing make sure to increment the version number [here](https://github.com/storyprotocol/storykit/blob/bdba305b644e08a9245e69ee7ba087da5f82c58b/packages/storykit/package.json#L4) + +When new changes are pushed to the branch defined [in the publish-package.yml workflow here](https://github.com/storyprotocol/storykit/blob/bdba305b644e08a9245e69ee7ba087da5f82c58b/.github/workflows/publish-package.yml#L6), a new [github action](https://github.com/storyprotocol/storykit/actions) will be started. + +As long as the version defined in the [package.json](https://github.com/storyprotocol/storykit/blob/bdba305b644e08a9245e69ee7ba087da5f82c58b/packages/storykit/package.json#L4) hasn't already been published, a new storykit package will be published, otherwise the action will fail. + +Storykit releases can be found [here](https://github.com/storyprotocol/storykit/pkgs/npm/storykit) + ## Deploying on vercel Add all the content of the `.npmrc` file, including your personal access token, to a `NPM_RC` vercel environment variable.