Deploy mdBook site to Pages #6
Workflow file for this run
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
| # Sample workflow for building and deploying a mdBook site to GitHub Pages | |
| # | |
| # To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html | |
| # | |
| 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: write | |
| 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.51 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install mdBook | |
| run: | | |
| curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh | |
| rustup update | |
| cargo install --version ${MDBOOK_VERSION} mdbook | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Copy PR previews | |
| # If there are no open PR's, this step will emit error messages that no | |
| # files matched and it does not look like a tar archive. These are | |
| # expected and don't indicate a problem. | |
| run: | | |
| mkdir -p public | |
| git fetch --depth=1 origin +gh-pages-test:refs/remotes/origin/gh-pages-test | |
| git archive --prefix=public/ refs/remotes/origin/gh-pages-test -- ':(top,glob)pr-*/**' | tar x || true | |
| - name: Add root files | |
| run: | | |
| cp CNAME public/ | |
| cp index.html public/ | |
| - name: Build Compiler User Guide with mdBook | |
| run: mdbook build | |
| working-directory: ./compiler-user-guide | |
| - name: Deploy site to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./public | |
| publish_branch: gh-pages-test |