Document process for breaking changes #150
Workflow file for this run
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: Continuous Integration | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| jobs: | |
| book-test: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Read .env | |
| id: mdbook-version | |
| run: | | |
| . ./.env | |
| echo "MDBOOK_VERSION=${MDBOOK_VERSION}" >> $GITHUB_OUTPUT | |
| echo "MDBOOK_LINKCHECK_VERSION=${MDBOOK_LINKCHECK_VERSION}" >> $GITHUB_OUTPUT | |
| echo "MDBOOK_TOC_VERSION=${MDBOOK_TOC_VERSION}" >> $GITHUB_OUTPUT | |
| - name: Cache binaries | |
| id: mdbook-cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| key: ${{ runner.os }}-${{ steps.mdbook-version.outputs.MDBOOK_VERSION }}--${{ steps.mdbook-version.outputs.MDBOOK_LINKCHECK_VERSION }}--${{ steps.mdbook-version.outputs.MDBOOK_TOC_VERSION }} | |
| - name: Install latest stable Rust toolchain | |
| if: steps.mdbook-cache.outputs.cache-hit != 'true' | |
| run: | | |
| rustup update stable | |
| rustup override set stable | |
| - name: Install Dependencies | |
| if: steps.mdbook-cache.outputs.cache-hit != 'true' | |
| run: | | |
| cargo install mdbook --version ${{ steps.mdbook-version.outputs.MDBOOK_VERSION }} | |
| cargo install mdbook-linkcheck --version ${{ steps.mdbook-version.outputs.MDBOOK_LINKCHECK_VERSION }} | |
| cargo install mdbook-toc --version ${{ steps.mdbook-version.outputs.MDBOOK_TOC_VERSION }} | |
| - name: Test book | |
| run: mdbook test | |
| book-build: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Read .env | |
| id: mdbook-version | |
| run: | | |
| . ./.env | |
| echo "MDBOOK_VERSION=${MDBOOK_VERSION}" >> $GITHUB_OUTPUT | |
| echo "MDBOOK_LINKCHECK_VERSION=${MDBOOK_LINKCHECK_VERSION}" >> $GITHUB_OUTPUT | |
| echo "MDBOOK_TOC_VERSION=${MDBOOK_TOC_VERSION}" >> $GITHUB_OUTPUT | |
| - name: Cache binaries | |
| id: mdbook-cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| key: ${{ runner.os }}-${{ steps.mdbook-version.outputs.MDBOOK_VERSION }}--${{ steps.mdbook-version.outputs.MDBOOK_LINKCHECK_VERSION }}--${{ steps.mdbook-version.outputs.MDBOOK_TOC_VERSION }} | |
| - name: Install latest stable Rust toolchain | |
| if: steps.mdbook-cache.outputs.cache-hit != 'true' | |
| run: | | |
| rustup update stable | |
| rustup override set stable | |
| - name: Install Dependencies | |
| if: steps.mdbook-cache.outputs.cache-hit != 'true' | |
| run: | | |
| cargo install mdbook --version ${{ steps.mdbook-version.outputs.MDBOOK_VERSION }} | |
| cargo install mdbook-linkcheck --version ${{ steps.mdbook-version.outputs.MDBOOK_LINKCHECK_VERSION }} | |
| cargo install mdbook-toc --version ${{ steps.mdbook-version.outputs.MDBOOK_TOC_VERSION }} | |
| - name: Build book for testing | |
| run: mdbook build |