From 6bf963068d5917ff710ec05f8899deb480a8f000 Mon Sep 17 00:00:00 2001 From: Tim Mikeladze Date: Mon, 11 Dec 2023 18:13:52 +0300 Subject: [PATCH] docs: update docs for publishing storybook --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 931e70c..9389573 100644 --- a/README.md +++ b/README.md @@ -94,9 +94,9 @@ When you are ready to publish to NPM simply run the following command: yarn publish ``` -#### 🤖 Auto publish after Github Release +#### 🤖 Auto publish after Github Release (or manually by dispatching the Publish workflow) -❗Important note: in order to automatically publish a Storybook on Github Pages you need to open your repository settings, navigate to "Actions" and enable "Read & write permissions" for Workflows. +❗Important note: in order to automatically publish a Storybook on Github Pages you need to open your repository settings, navigate to "Actions" and enable **"Read & write permissions"** for Workflows. Then navigate to "Pages" and choose **"GitHub Actions"** as the source for the Build and Deployment. After a successful deployment you can find your Storybook at `https://.github.io//`. ❗Important note: in order to publish package to NPM you must add your token as a Github Action secret. Learn more on how to configure your repository and publish packages through Github Actions [here](https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages).