[🤖 readme-manager] Update README (#11) #28
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: Generate docs and deploy to GitHub Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # 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: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| # Must be set to this for deploying to GitHub Pages | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: macos-12 | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v3 | |
| - name: Build DocC | |
| run: | | |
| xcodebuild docbuild -scheme LiveKitComponents \ | |
| -derivedDataPath /tmp/docbuild \ | |
| -destination 'generic/platform=iOS'; | |
| $(xcrun --find docc) process-archive \ | |
| transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/LiveKitComponents.doccarchive \ | |
| --hosting-base-path /components-swift \ | |
| --output-path docs; | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| # Upload only docs directory | |
| path: "docs" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |