documentation.yml

name: Documentation + Storybook

env:
    SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
    SLACK_CHANNEL_ID: ${{ secrets.SLACK_CHANNEL_ID }}

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/**"
            - "src/modules/**/*.md"
            - ".github/workflows/documentation.yml"
    workflow_dispatch:

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

concurrency:
    group: "pages"
    cancel-in-progress: true

jobs:
    slack-start:
        name: Slack start message
        runs-on: ubuntu-latest
        outputs:
            channel_id: ${{ steps.slack-start.outputs.channel_id }}
            ts: ${{ steps.slack-start.outputs.ts }}
        steps:
            - name: checkout repository
              uses: actions/checkout@v6

            - name: send slack start message
              id: slack-start
              uses: ./.github/actions/slack-run-start
              with:
                  message_prefix: Workflow running

    # 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

    slack-finish:
        name: Slack final status
        if: ${{ always() && needs.slack-start.result == 'success' && needs.slack-start.outputs.ts != '' }}
        needs:
            - slack-start
            - codespell
            - storybook
            - pages
            - deploy
        runs-on: ubuntu-latest
        steps:
            - name: checkout repository
              uses: actions/checkout@v6

            - name: set end timestamp
              id: end-time
              run: echo "value=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> "$GITHUB_OUTPUT"

            - name: determine workflow status
              id: workflow-status
              run: |
                  workflow_status="success"
                  if [[ "${{ needs.codespell.result }}" == "failure" || "${{ needs.codespell.result }}" == "cancelled" || "${{ needs.storybook.result }}" == "failure" || "${{ needs.storybook.result }}" == "cancelled" || "${{ needs.pages.result }}" == "failure" || "${{ needs.pages.result }}" == "cancelled" || "${{ needs.deploy.result }}" == "failure" || "${{ needs.deploy.result }}" == "cancelled" ]]; then
                      workflow_status="failure"
                  fi
                  echo "status=$workflow_status" >> "$GITHUB_OUTPUT"

            - name: update slack message
              uses: ./.github/actions/slack-run-finish
              with:
                  channel_id: ${{ needs.slack-start.outputs.channel_id }}
                  ts: ${{ needs.slack-start.outputs.ts }}
                  status: ${{ steps.workflow-status.outputs.status }}
                  message_prefix: Workflow