Merge pull request #67 from darbiadev/shenanigansd-patch-1 #5
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 - Rust doc" | ||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| deploy: | ||
| description: "Whether to deploy the built site" | ||
| default: ${{ github.ref == 'refs/heads/main' }} | ||
| required: false | ||
| type: boolean | ||
| ` | ||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: "Checkout repository" | ||
| uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 | ||
| - name: "Build docs with cargo" | ||
| run: cargo doc --no-deps --document-private-items | ||
| - name: "Upload artifact" | ||
| uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2.0.0 | ||
| with: | ||
| path: ./target/doc | ||
| deploy: | ||
| if: ${{ inputs.deploy }} | ||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| 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@12ab2b16cf43a7a061fe99da74b6f8f11fb77f5b # v2.0.3 | ||
