book: Document the monitor API (#83) #6
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
| # Based on <https://github.com/rust-lang/mdBook/wiki/Automated-Deployment:-GitHub-Actions/6cd0e9edbaf9f5b3ae495ece9d48f4145d001d14> | |
| name: Deploy book | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # To push a branch | |
| pages: write # To push to a GitHub Pages site | |
| id-token: write # To update the deployment status | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Configure PATH | |
| run: | | |
| mkdir -p opt/mdbook | |
| mkdir -p opt/mdbook-mermaid | |
| echo "$(pwd)/opt/mdbook" >> $GITHUB_PATH | |
| echo "$(pwd)/opt/mdbook-mermaid" >> $GITHUB_PATH | |
| - name: Install latest mdbook | |
| run: | | |
| tag=v0.4.52 | |
| url="https://github.com/rust-lang/mdbook/releases/download/$tag/mdbook-$tag-x86_64-unknown-linux-gnu.tar.gz" | |
| curl -sSL "$url" | tar -xz --directory=./opt/mdbook | |
| - name: Install latest mdbook-mermaid | |
| run: | | |
| tag=v0.16.2 | |
| url="https://github.com/badboy/mdbook-mermaid/releases/download/$tag/mdbook-mermaid-$tag-x86_64-unknown-linux-gnu.tar.gz" | |
| curl -sSL "$url" | tar -xz --directory=./opt/mdbook-mermaid | |
| - name: Build book | |
| run: | | |
| cd book | |
| mdbook build | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: book/book | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |