Skip to content

Documentation workflow #23

Documentation workflow

Documentation workflow #23

# Simple workflow for deploying static content to GitHub Pages
name: Deploy Documentation
on:
# Runs on pushes targeting the default branch
push:
branches:
- 'main'
- 'gh-pages'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: '18'
cache: 'yarn'
- name: Install global ependencies
run: yarn install --immutable
- name: Install dependencies
working-directory: ./packages/components
run: yarn install --immutable
- name: Build documentation
working-directory: ./packages/components
run: yarn storybook:generate && yarn storybook:build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './packages/components/storybook-static'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2