docs: improve readability of color docs (#63) #9
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: Publish Docs | |
| 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: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # change to macos-latest once macos-13 becomes the latest | |
| runs-on: macos-13 | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v3 | |
| - uses: swift-actions/setup-swift@v1 | |
| with: | |
| swift-version: "5.8" | |
| - uses: actions/cache@v3 | |
| with: | |
| path: .build | |
| key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }} | |
| restore-keys: | | |
| ${{ runner.os }}-spm- | |
| - name: Package documentation 🛠 | |
| run: | | |
| export DOCC_JSON_PRETTYPRINT="YES" | |
| swift package generate-documentation \ | |
| --target WMATAUI \ | |
| --include-extended-types \ | |
| --disable-indexing \ | |
| --transform-for-static-hosting \ | |
| --hosting-base-path WMATAUI.swift | |
| - name: Upload artifact 📜 | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| # Upload docs directory | |
| path: .build/plugins/Swift-DocC/outputs/WMATAUI.doccarchive | |
| - name: Deploy to GitHub Pages 🐙 | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |