SwiftNASR/.github/workflows/doc.yml at master · RISCfuture/SwiftNASR · 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
name: Deploy Documentation

on:
  push:
    branches: [master]
  workflow_dispatch:

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

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

jobs:
  build:
    name: Generate Documentation
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v6
      - uses: SwiftyLab/setup-swift@latest
        with:
          swift-version: "6.2"
      - name: Build
        run: |
          swift package \
           --allow-writing-to-directory ./docs \
           generate-documentation --target SwiftNASR --output-path ./docs \
           --disable-indexing \
           --transform-for-static-hosting \
           --hosting-base-path SwiftNASR
      - name: Create root redirect
        run: |
          cat > ./docs/index.html << 'EOF'
          <!DOCTYPE html>
          <html lang="en">
          <head>
              <meta charset="UTF-8">
              <meta http-equiv="refresh" content="0; url=/SwiftNASR/documentation/swiftnasr/">
              <title>SwiftNASR Documentation</title>
              <script>
                  window.location.replace("/SwiftNASR/documentation/swiftnasr/");
              </script>
          </head>
          <body>
              <p>Redirecting to <a href="/SwiftNASR/documentation/swiftnasr/">SwiftNASR Documentation</a>...</p>
          </body>
          </html>
          EOF
      - name: Upload
        uses: actions/upload-pages-artifact@v5
        with:
          path: "docs/"

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