Standardize CI matrix policy and doc workflow #54
This file contains hidden or 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 Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Generate Documentation | |
| runs-on: macos-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: SwiftyLab/setup-swift@latest | |
| with: | |
| swift-version: "6.2" | |
| - name: Build | |
| run: | | |
| swift package \ | |
| --allow-writing-to-directory ./docs \ | |
| generate-documentation \ | |
| --target SwiftMETAR --target METARFormatting \ | |
| --output-path ./docs \ | |
| --disable-indexing \ | |
| --transform-for-static-hosting \ | |
| --hosting-base-path SwiftMETAR \ | |
| --enable-experimental-combined-documentation | |
| - name: Create root redirect | |
| run: | | |
| cat > ./docs/index.html << 'EOF' | |
| <!DOCTYPE html> | |
| <html lang="en"> | |
| <head> | |
| <meta charset="UTF-8"> | |
| <meta http-equiv="refresh" content="0; url=/SwiftMETAR/documentation/swiftmetar/"> | |
| <title>SwiftMETAR Documentation</title> | |
| <script> | |
| window.location.replace("/SwiftMETAR/documentation/swiftmetar/"); | |
| </script> | |
| </head> | |
| <body> | |
| <p>Redirecting to <a href="/SwiftMETAR/documentation/swiftmetar/">SwiftMETAR Documentation</a>...</p> | |
| </body> | |
| </html> | |
| EOF | |
| - name: Upload | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "docs/" | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |