Documentation #8
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Compile and Deploy Documentation | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| jobs: | |
| build: | |
| runs-on: macos-13 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Initialise Submodule | |
| run: git submodule init && git submodule update | |
| - name: Select Xcode 15.1 | |
| run: sudo xcode-select -s /Applications/Xcode_15.1.app/Contents/Developer | |
| - name: Create Documentation Archive | |
| run: > | |
| xcrun xcodebuild docbuild \ | |
| -scheme FeedRadar \ | |
| -destination 'generic/platform=iOS Simulator' \ | |
| -derivedDataPath .derivedData | |
| - name: Transform Archive for Static Hosting | |
| run: > | |
| xcrun docc process-archive transform-for-static-hosting \ | |
| .derivedData/Build/Products/Debug-iphonesimulator/FeedRadar.doccarchive \ | |
| --output-path .docs \ | |
| --hosting-base-path feed-radar | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: .docs | |
| deploy: | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |