bitovi/github-actions-storybook-to-github-pages builds and deploys a Storybook application to GitHub Pages.

This action uses the new GitHub Actions publishing method which allows you to create an artifact that contains the result of the build and serves the files in the artifact on the Pages site. There’s no need to check files back into your repository, keeping it nice and clean.

This action deploys Storybook to Github Pages. The build process should create static files and put them into a build direcory that will be moved into your Pages hosting location.

If you would like to deploy a backend app/service, check out our other actions:

And more!, check our list of actions in the GitHub marketplace

This project is supported by Bitovi, A DevOps consultancy.

You can get help or ask questions on our:

• Discord Community

Or, you can hire us for training, consulting, or development. Set up a free consultation.

**Note: ** Be sure to set up your project for actions deployed pages.

For basic usage, create .github/workflows/deploy.yaml with the following to build on push.

on:
  push:
    branches:
      - "main" # change to the branch you wish to deploy from

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - id: build-publish
      uses: bitovi/[email protected]
      with:
        path: build # change to your build folder

• In the project repo in GitHub, go to Settings > Pages.
• For the source, select GitHub Actions
• No further configuration is needed.

Note: Your Repository must be set to public for GitHub Pages to serve content.

The following inputs can be used as step.with keys

To surface published url to the root of the repo via a GitHub Environment, add the following to your workflow:

# ...etc
jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.build-publish.outputs.page_url }}
    # ...etc

Note: This is helpful when you have a custom domain

on:
  push:
    branches:
      - "main" # change to the branch you wish to deploy from

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.build-publish.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
    - id: build-publish
      uses: bitovi/[email protected]
      with:
        path: build # change to your build folder
        install_command: yarn install
        build_command: yarn run build-storybook

• How to Deploy Storybook to GitHub Pages with GitHub Actions

We would love for you to contribute to bitovi/github-actions-storybook-to-github-pages. Issues and Pull Requests are welcome!

The scripts and documentation in this project are released under the MIT License.

Bitovi is a proud supporter of Open Source software.

Come chat with us about open source in our Bitovi community Discord!