Remove reference to name field in the ubrn.config.yaml docs (#189) #80
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: Deploy mdBook site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| MDBOOK_VERSION: 0.4.36 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jontze/action-mdbook@v3 | |
| with: | |
| token: ${{secrets.GITHUB_TOKEN}} | |
| # Optional Plugins have to be enabled | |
| use-linkcheck: true | |
| use-mermaid: false | |
| use-toc: true | |
| use-opengh: true | |
| use-admonish: true | |
| use-katex: false | |
| - name: Show mdbook version | |
| run: mdbook --version | |
| - name: Show linkchecker version | |
| run: mdbook-linkcheck --version | |
| # - name: Show mermaid version | |
| # run: mdbook-mermaid --version | |
| - name: Show toc version | |
| run: mdbook-toc --version | |
| - name: Show open-on-gh version | |
| run: mdbook-open-on-gh --version | |
| - name: Show admonish version | |
| run: mdbook-admonish --version | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build with mdBook | |
| run: mdbook build docs | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/book/html | |
| # Deployment job | |
| deploy: | |
| 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@v4 |