Update README.md #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: Deploy DocC to GitHub Pages | |
| on: | |
| # trigger this workflow whenever "main" branch has been pushed | |
| push: | |
| branches: [ "main" ] | |
| # Set up GITHUB_TOKEN permission for the deployment | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow workflow concurrency | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| environment: | |
| # Mandatory settings for GitHub Pages deployment | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: macos-13 # to use the latest version that is available on GitHub Actions | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v3 | |
| - name: Setup Xcode version | |
| uses: maxim-lobanov/setup-xcode@v1 # To set up xcode version | |
| with: | |
| xcode-version: '15.0' | |
| - name: Build DocC | |
| run: | # If you use docc-plugin, you might be able to use docc-plugin command instead | |
| swift package --allow-writing-to-directory docs \ | |
| generate-documentation --target ForceSimulation \ | |
| --disable-indexing \ | |
| --transform-for-static-hosting \ | |
| --hosting-base-path Grape \ | |
| --output-path docs && swift ./DocPostprocess.swift | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| # Upload docs folder | |
| path: 'docs' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |