docs: rewrite README in canonical structure (#6) #15
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: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: macos-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Setup Xcode | |
| uses: maxim-lobanov/setup-xcode@v1 | |
| with: | |
| xcode-version: latest-stable | |
| - name: Build Documentation | |
| run: | | |
| xcodebuild docbuild \ | |
| -scheme SwiftUIInterfaceOrientation \ | |
| -destination "generic/platform=iOS Simulator" \ | |
| -derivedDataPath .derivedData | |
| $(xcrun --find docc) process-archive transform-for-static-hosting \ | |
| .derivedData/Build/Products/Debug-iphonesimulator/SwiftUIInterfaceOrientation.doccarchive \ | |
| --hosting-base-path swiftui-interface-orientation \ | |
| --output-path ./docs | |
| - name: Add redirect to root | |
| run: | | |
| cat > ./docs/index.html << 'EOF' | |
| <!DOCTYPE html> | |
| <html> | |
| <head> | |
| <meta http-equiv="refresh" content="0; url=documentation/swiftuiinterfaceorientation/"> | |
| </head> | |
| </html> | |
| EOF | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: ./docs | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |