introduce a build-rs and a cargo-duchess utility (#187)
#132
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
| # 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: 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.21 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| cache-all-crates: true | |
| # Needed so that the coverage tests can actually work & rustdoc can successfully build examples | |
| - uses: actions/setup-java@v3 | |
| with: | |
| distribution: 'corretto' | |
| java-version: '17' | |
| - name: Install mdBook | |
| run: | | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.28/mdbook-v0.4.28-x86_64-unknown-linux-gnu.tar.gz | tar -xz | |
| # 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@v3 | |
| - name: Build with mdBook | |
| run: ./mdbook build book | |
| #- name: stub | |
| # run: mkdir -p target/ui-coverage-report && echo "hello world!" > target/ui-coverage-report/index.html | |
| - name: install just | |
| run: | | |
| cargo install just | |
| - name: coverage-deps | |
| run: just coverage-tools | |
| - name: | |
| run: just coverage | |
| env: | |
| NO_OPEN: true | |
| # Needed so that mdbook can point directly to rustdoc | |
| - name: Rust rustdoc | |
| run: cargo doc --target-dir book/book/rustdoc | |
| - name: Assemble pages | |
| run: | | |
| mv book/book pages-site | |
| mv target/ui-coverage-report pages-site/coverage | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: ./pages-site/ | |
| # 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@v2 |