Link formatting; minor edits #39
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: Build and test the mdbook-utils code; build, test, and deploy its user guide (mdBook site) to Pages | |
| ## To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html | |
| 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 | |
| steps: | |
| - name: Basic information | |
| run: echo "The job was automatically triggered by a ${{ github.event_name }} event from @${{ github.actor }}. The OS is ${{ runner.os }}. The current dir is $(pwd)" | |
| - name: Code checkout | |
| uses: actions/checkout@v4 | |
| - name: Create output folder | |
| run: mkdir -p -v ./user_guide_book/ | |
| - name: Build the Docker image; build and test the code and the user guide | |
| run: docker compose -f .devcontainer/compose.yaml -f .devcontainer/compose-ci.yaml run --build --rm mdbook-utils | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./user_guide_book/ | |
| ## 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 |