Update readme with pages doc #3
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
| on: | |
| push: | |
| branches: | |
| - main | |
| name: Build and deploy docs | |
| permissions: | |
| pages: write | |
| id-token: write | |
| contents: read | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| profile: minimal | |
| components: rust-docs | |
| - name: Build docs | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: doc | |
| args: --no-deps --all-features | |
| - name: Finalize documentation | |
| run: | | |
| echo "<meta http-equiv=\"refresh\" content=\"0; url=paladin\">" > target/doc/index.html | |
| - name: Fix permissions | |
| run: | | |
| chmod -c -R +rX "target/doc/" | while read line; do | |
| echo "::warning title=Invalid file permissions automatically fixed::$line" | |
| done | |
| - name: Upload as artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: target/doc | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: https://mir-protocol.github.io/paladin | |
| runs-on: ubuntu-latest | |
| needs: build-docs | |
| steps: | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |