bug/.github/workflows/documentation.yml at main · bbc/bug · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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"
            - "src/modules/**/module.json"
            - ".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:
            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

    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,rouge,te

    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

    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: Add Storybook to docs
              run: |
                  mkdir -p docs/storybook
                  cp -a storybook-static/* docs/storybook/

            - name: Setup Node
              uses: actions/setup-node@v3
              with:
                  node-version: 20

            - name: Install Dependencies
              run: npm ci

            - 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:
        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:
                  ts: ${{ needs.slack-start.outputs.ts }}
                  status: ${{ steps.workflow-status.outputs.status }}
                  message_prefix: Workflow