init

.github/workflows/build-docs.yml

@@ -29,17 +29,12 @@ jobs:
     runs-on: macos-12
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+      - name: Setup Xcode
+        uses: maxim-lobanov/setup-xcode@v1
         with:
-          ruby-version: 3.0
-
-      - name: Install dependencies
-        run: gem install jazzy
-
-      - name: Generate documentation
-        run: jazzy --output ./docs --theme=fullwidth
-
+          xcode-version: latest-stable
+      - name: "Build docs"
+        run: xcodebuild docbuild -scheme XMTP -destination 'generic/platform=ios' -quiet
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

.github/workflows/docs.yml

@@ -1,35 +1,51 @@
-name: Generate docs content to Pages (jazzy)
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy docs content to Pages
 
 on:
+  # Runs on pushes targeting the default branch
   push:
-    branches: ["docs_build_v1"]
-  pull_request:
-    branches: ["docs_build_v1"]
+    branches: ["main", "docs"]
+
+  # Allows you to run this workflow manually from the Actions tab
   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.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: "pages"
   cancel-in-progress: false
 
 jobs:
   deploy:
-    runs-on: macos-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-12
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.0
 
+      - name: Install dependencies
+        run: gem install jazzy
+
+      - name: Generate documentation
+        run: jazzy --output ./docs --theme=fullwidth
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: "./docs"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs