From 38625a00c313192d0edbe1c3a855bea1ec56bd2b Mon Sep 17 00:00:00 2001 From: Zach Plata Date: Thu, 9 Jun 2022 09:20:43 -0500 Subject: [PATCH] Maint: Add GH workflow for deploying storybook to Github Pages --- .github/workflows/storybook.yml | 28 ++++++++++++++++++++++++++++ docs/.gitignore | 0 package.json | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/storybook.yml create mode 100644 docs/.gitignore diff --git a/.github/workflows/storybook.yml b/.github/workflows/storybook.yml new file mode 100644 index 0000000..e12bcfd --- /dev/null +++ b/.github/workflows/storybook.yml @@ -0,0 +1,28 @@ +name: Deploy Storybook +on: + pull_request: + types: [closed] + branches: + - main + paths: ['src', 'examples/stories/**'] # Trigger the action only when files change in the folders defined here +jobs: + build-and-deploy: + runs-on: ubuntu-latest + if: github.event.pull_request.merged == true + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v2 + with: + persist-credentials: false + - name: Install and Build 🔧 + run: | # Install npm packages and build the Storybook files + npm install + npm run build-storybook + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@3.6.2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: main # The branch the action should deploy to. + FOLDER: docs-build # The folder that the build-storybook script generates files. + CLEAN: true # Automatically remove deleted files from the deploy branch + TARGET_FOLDER: docs # The folder that we serve our Storybook files from diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json index 0f69699..cd41210 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "types:check": "tsc --noEmit", "release": "release-it", "storybook": "start-storybook -p 6006", - "build-storybook": "build-storybook" + "build-storybook": "build-storybook -o docs-build" }, "repository": { "type": "git",