Skip to content

Commit

Permalink
ci: add docc generator
Browse files Browse the repository at this point in the history
  • Loading branch information
Akazm committed Dec 16, 2024
1 parent 4670c5a commit 155bed2
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/docc.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions scripts/docc.sh
Original file line number Diff line number Diff line change
@@ -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 "<script>window.location.href += \"/documentation/tapguard\"</script>" > docs/index.html;

0 comments on commit 155bed2

Please sign in to comment.