Merge branch 'main' of https://github.com/bbc/bug #318
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/src/components/**" | |
| 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 merge Storybook | |
| 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 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| # Build Jekyll site into temporary folder | |
| - name: Build Jekyll Site | |
| uses: actions/jekyll-build-pages@v1 | |
| with: | |
| source: ./docs | |
| destination: ./jekyll_site | |
| # Merge Storybook into site | |
| - name: Merge Storybook into site | |
| run: | | |
| mkdir -p jekyll_site/storybook | |
| cp -a storybook-static/* jekyll_site/storybook/ | |
| # Upload merged site as Pages artifact | |
| - name: Upload Pages Artifact | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: jekyll_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 |