update README #6
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: Deploy DocC Documentation to Github Pages | |
| on: | |
| # Runs on pushes targeting the master branch | |
| push: | |
| branches: ["main"] | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| env: | |
| SCHEME: SYBanner | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # One deployment deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| # Must set to this for deploying to GitHub Pages | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: macos-14 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| with: | |
| enablement: true | |
| - name: Select Xcode 16.0 | |
| uses: maxim-lobanov/setup-xcode@v1 | |
| with: | |
| xcode-version: '16.0.0' | |
| - name: Verify Swift Version | |
| run: swift --version | |
| - name: Build DocC | |
| run: | | |
| swift package resolve; | |
| xcodebuild docbuild \ | |
| -scheme $SCHEME \ | |
| -derivedDataPath /tmp/docbuild \ | |
| -destination 'generic/platform=iOS' \ | |
| CODE_SIGNING_ALLOWED=NO | |
| echo "Archiving documentation..." | |
| $(xcrun --find docc) process-archive \ | |
| transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/$SCHEME.doccarchive \ | |
| --output-path docs \ | |
| --hosting-base-path ${SCHEME}; | |
| echo "** Archived documentation**" | |
| # Define the lowercase version of SCHEME | |
| lowerCaseScheme=$(echo $SCHEME | tr '[:upper:]' '[:lower:]') | |
| # Use the lowercase variable in the redirect script | |
| echo "<script>window.location.href += \"/documentation/${lowerCaseScheme}\"</script>" > docs/index.html; | |
| - 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 |