Deploy API documentation to Pages

Neno Stefanov · Neno Stefanov · commit 7ef3c443b4aa · 2025-07-21T16:35:52.000+03:00
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,55 @@
+name: Deploy API documentation to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: 
+      - '*'
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Generate documentation
+        run: |
+          swift package --allow-writing-to-directory ./docs \
+            generate-documentation --target MIRACLTrust \
+            --disable-indexing \
+            --transform-for-static-hosting \
+            --hosting-base-path trust-sdk-ios \
+            --output-path ./docs
+
+      - name: Add redirect to the reference
+        run: cp -f ./documentation/redirect.html ./docs/index.html
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload the generated HTML
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -39,6 +39,7 @@ let package = Package(
         )
     ],
     dependencies: [
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.4.5"),
     ],
     targets: [
         .target(
diff --git a/documentation/redirect.html b/documentation/redirect.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=./documentation/miracltrust/">
+    <title>Redirecting…</title>
+  </head>
+  <body>
+    <p>Redirecting to <a href="./documentation/miracltrust/">documentation</a>...</p>
+  </body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ let package = Package(`
`39`	`39`	`)`
`40`	`40`	`],`
`41`	`41`	`dependencies: [`
	`42`	`+ .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.4.5"),`
`42`	`43`	`],`
`43`	`44`	`targets: [`
`44`	`45`	`.target(`