Merge pull request #30 from rust3ds/feature/gh-pages-docs #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: GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| container: devkitpro/devkitarm | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@v4 | |
| - uses: rust3ds/test-runner/setup@v1 | |
| with: | |
| toolchain: nightly | |
| - name: Build workspace docs | |
| run: cargo 3ds --verbose doc --verbose --no-deps --workspace | |
| env: | |
| # TODO: might want a custom index page ? | |
| # https://doc.rust-lang.org/rustdoc/unstable-features.html#--index-page-provide-a-top-level-landing-page-for-docs | |
| RUSTDOCFLAGS: "--enable-index-page" | |
| # https://github.com/actions/upload-pages-artifact#file-permissions | |
| - name: Fix file permissions | |
| run: | | |
| chmod -c -R +rX "target/armv6k-nintendo-3ds/doc" | while read line; do | |
| echo "::warning title=Invalid file permissions automatically fixed::$line" | |
| done | |
| - name: Upload generated docs | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: ./target/armv6k-nintendo-3ds/doc | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 | |