diff --git a/.github/workflows/docc.yml b/.github/workflows/docc.yml new file mode 100644 index 0000000..36f5de8 --- /dev/null +++ b/.github/workflows/docc.yml @@ -0,0 +1,47 @@ +# This workflow builds publish DocC docs to GitHub Pages. +# Source: https://maxxfrazer.medium.com/deploying-docc-with-github-actions-218c5ca6cad5 +# Sample: https://github.com/AgoraIO-Community/VideoUIKit-iOS/blob/main/.github/workflows/deploy_docs.yml + +name: DocC Runner + +on: + push: + branches: ["master"] + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: macos-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - id: pages + name: Setup Pages + uses: actions/configure-pages@v4 + - name: Select Xcode version + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: '16.2' + - name: Build DocC + run: | + bash scripts/docc.sh + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs' + - id: deployment + name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/scripts/docc.sh b/scripts/docc.sh new file mode 100644 index 0000000..1e48a9a --- /dev/null +++ b/scripts/docc.sh @@ -0,0 +1,7 @@ +xcodebuild docbuild -scheme tap-guard -destination 'generic/platform=macOS' -derivedDataPath "$PWD/.derivedData" +$(xcrun --find docc) process-archive \ + transform-for-static-hosting "$PWD/.derivedData/Build/Products/Debug/TapGuard.doccarchive" \ + --output-path .docs + --hosting-base-path "TapGuard" + +echo "" > docs/index.html; \ No newline at end of file