Merge branch 'main' of https://github.com/bbc/bug #336
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation + Storybook | |
| on: | |
| push: | |
| branches: ["main"] | |
| paths: | |
| - "docs/**" | |
| - "src/client/.storybook/**" | |
| - "src/client/src/**/*.stories.@(js|jsx|ts|tsx)" | |
| - "src/client/src/**/*.mdx" | |
| - "src/client/src/components/**" | |
| - "src/client/src/core/**" | |
| - "src/client/src/hooks/**" | |
| - "src/client/src/utils/**" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # spell check documentation | |
| codespell: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Spell Check Documentation | |
| uses: codespell-project/actions-codespell@master | |
| with: | |
| check_filenames: true | |
| check_hidden: true | |
| path: docs | |
| only_warn: 1 | |
| ignore_words_list: aoto,daa,te | |
| # build storybook | |
| storybook: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Build Storybook | |
| run: | | |
| cd src/client | |
| npm run build-storybook -- --output-dir storybook-static | |
| - name: Upload Storybook Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: storybook | |
| path: src/client/storybook-static | |
| # build jekyll docs and include storybook + modules | |
| pages: | |
| runs-on: ubuntu-latest | |
| needs: storybook | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Download Storybook Artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: storybook | |
| path: storybook-static | |
| # merge storybook into docs folder before Jekyll build | |
| - name: Add Storybook to docs | |
| run: | | |
| mkdir -p docs/storybook | |
| cp -a storybook-static/* docs/storybook/ | |
| # setup node (needed to run modules generator) | |
| - name: Setup Node | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| # install dependencies for modules script (js-yaml, etc.) | |
| - name: Install Dependencies | |
| run: npm ci | |
| # generate modules pages before building site | |
| - name: Generate Modules Pages | |
| run: node docs/scripts/generateModules.js | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build Jekyll Site | |
| uses: actions/jekyll-build-pages@v1 | |
| with: | |
| source: ./docs | |
| destination: ./_site | |
| - name: Upload Pages Artifact | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: ./_site | |
| # deploy to github pages | |
| deploy: | |
| needs: pages | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |