ProgressUI/.github/workflows/docs.yml at develop · PierreJanineh-com/ProgressUI · 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
name: Documentation

on:
  push:
    branches: [main]
  workflow_dispatch:

# Allow the workflow to publish to GitHub Pages.
permissions:
  contents: read
  pages: write
  id-token: write

# Only one Pages deployment at a time; cancel superseded runs.
concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    name: Build DocC
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4

      - name: Generate documentation
        run: |
          swift package --allow-writing-to-directory ./docs \
            generate-documentation \
            --target ProgressUI \
            --disable-indexing \
            --transform-for-static-hosting \
            --hosting-base-path ProgressUI \
            --output-path ./docs

      # DocC has no landing page at the site root, so the bare Pages URL renders
      # "page can't be found". Redirect the root to the module's documentation.
      - name: Redirect site root to the module documentation
        run: |
          cat > ./docs/index.html <<'HTML'
          <!DOCTYPE html>
          <html lang="en">
            <head>
              <meta charset="utf-8">
              <title>ProgressUI</title>
              <meta http-equiv="refresh" content="0; url=documentation/progressui">
              <link rel="canonical" href="documentation/progressui">
            </head>
            <body>
              Redirecting to the <a href="documentation/progressui">ProgressUI documentation</a>…
            </body>
          </html>
          HTML

      - uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs

  deploy:
    name: Deploy to Pages
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4