storybook.yml

# This is a basic workflow to help you get started with Actions          

name: Storybook Deploy

# Controls when the workflow will run
on: 
  
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
  
    paths: ["stories/**", "src/components/**"] # Trigger the action only when files change in the folders defined here

jobs:

  build-and-deploy:
  
    runs-on: ubuntu-latest
    
    steps:
    
      - name: Checkout 🛎️
        uses: actions/checkout@v3
        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@v4
        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