Hephaestus/.github/workflows/cd-docs.yml at beaf025c446b8629ec35acabfd4af048c80b68e8 · ls1intum/Hephaestus · 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
name: CD / Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/cd-docs.yml"
  pull_request:
    types: [opened, synchronize, reopened]
    paths:
      - "docs/**"
      - ".github/workflows/cd-docs.yml"
  workflow_dispatch:

concurrency:
  group: docs-deploy-${{ github.event_name == 'pull_request' && format('pr-{0}', github.event.number) || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read
  pages: write
  id-token: write
  pull-requests: write
  statuses: write

jobs:
  build-preview:
    name: Build (preview)
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: ./.github/actions/setup-bun
      - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: |
            docs/.docusaurus
            docs/node_modules/.cache
          key: ${{ runner.os }}-docusaurus-preview-${{ hashFiles('bun.lock') }}-${{ hashFiles('docs/**/*.md', 'docs/**/*.mdx', 'docs/**/*.ts') }}
          restore-keys: |
            ${{ runner.os }}-docusaurus-preview-${{ hashFiles('bun.lock') }}-
            ${{ runner.os }}-docusaurus-preview-
      - run: bun install --frozen-lockfile
      - run: bun run --filter docs build
        env:
          DOCUSAURUS_BASE_URL: "/"
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs-build-preview
          path: docs/build
          retention-days: 1

  build-production:
    name: Build (production)
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: ./.github/actions/setup-bun
      - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: |
            docs/.docusaurus
            docs/node_modules/.cache
          key: ${{ runner.os }}-docusaurus-production-${{ hashFiles('bun.lock') }}-${{ hashFiles('docs/**/*.md', 'docs/**/*.mdx', 'docs/**/*.ts') }}
          restore-keys: |
            ${{ runner.os }}-docusaurus-production-${{ hashFiles('bun.lock') }}-
            ${{ runner.os }}-docusaurus-production-
      - run: bun install --frozen-lockfile
      - run: bun run --filter docs build
        env:
          DOCUSAURUS_BASE_URL: "/Hephaestus/"
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs-build-production
          path: docs/build
          retention-days: 1

  preview:
    name: PR Preview
    needs: build-preview
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    env:
      PREVIEW_URL: ls1intum-hephaestus-docs-pr-${{ github.event.number }}.surge.sh
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: docs-build-preview
          path: docs-build
      - uses: ./.github/actions/setup-bun
      - run: bun install --frozen-lockfile --ignore-scripts
      - name: Deploy to Surge.sh
        run: bun --bun surge ./docs-build ${{ env.PREVIEW_URL }} --token ${{ secrets.SURGE_TOKEN }}
      - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
        with:
          header: docs-preview
          message: |
            ## 📚 Documentation Preview

            This PR includes documentation changes. A preview has been deployed:

            🔗 **[View Docs Preview](https://${{ env.PREVIEW_URL }})**

            <sub>Preview for commit ${{ github.event.pull_request.head.sha }}. Updates automatically on new commits.</sub>
      - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        with:
          script: |
            const sha = context.payload.pull_request?.head?.sha || context.sha;
            await github.rest.repos.createCommitStatus({
              owner: context.repo.owner,
              repo: context.repo.repo,
              sha: sha,
              state: 'success',
              target_url: 'https://${{ env.PREVIEW_URL }}',
              description: 'Click Details to view Docs Preview',
              context: 'Preview / Docs'
            });

  deploy:
    name: GitHub Pages
    needs: build-production
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: docs-build-production
          path: docs-build
      - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
        with:
          path: docs-build
      - id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4