modules: describe both module filename styles without giving a clear preference #2430
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: CI | |
| on: | |
| pull_request: | |
| merge_group: | |
| env: | |
| MDBOOK_VERSION: 0.4.43 | |
| jobs: | |
| code-tests: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@master | |
| - name: Update rustup | |
| run: rustup self update | |
| - name: Install Rust | |
| run: | | |
| rustup set profile minimal | |
| rustup toolchain install nightly | |
| rustup default nightly | |
| - name: Install mdbook | |
| run: | | |
| mkdir bin | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$(pwd)/bin" >> $GITHUB_PATH | |
| - name: Report versions | |
| run: | | |
| rustup --version | |
| rustc -Vv | |
| mdbook --version | |
| - name: Run tests | |
| run: mdbook test | |
| style-tests: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@master | |
| - name: Checkout rust-lang/rust | |
| uses: actions/checkout@master | |
| with: | |
| repository: rust-lang/rust | |
| path: rust | |
| - name: Update rustup | |
| run: rustup self update | |
| - name: Install Rust | |
| run: | | |
| rustup set profile minimal | |
| rustup toolchain install nightly -c rust-docs,rustfmt | |
| rustup default nightly | |
| - name: Install mdbook | |
| run: | | |
| mkdir bin | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$(pwd)/bin" >> $GITHUB_PATH | |
| - name: Report versions | |
| run: | | |
| rustup --version | |
| rustc -Vv | |
| mdbook --version | |
| - name: Style checks | |
| working-directory: style-check | |
| run: cargo run --locked -- ../src | |
| - name: Style fmt | |
| working-directory: style-check | |
| run: cargo fmt --check | |
| - name: Verify the book builds | |
| env: | |
| SPEC_DENY_WARNINGS: 1 | |
| SPEC_RUST_ROOT: ${{ github.workspace }}/rust | |
| run: mdbook build | |
| - name: Check for broken links | |
| run: | | |
| curl -sSLo linkcheck.sh \ | |
| https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh | |
| sh linkcheck.sh --all reference | |
| mdbook-spec: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@master | |
| - name: Update rustup | |
| run: rustup self update | |
| - name: Install Rust | |
| run: | | |
| rustup set profile minimal | |
| rustup toolchain install nightly -c rustfmt | |
| rustup default nightly | |
| - name: Install mdbook | |
| run: | | |
| mkdir bin | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$(pwd)/bin" >> $GITHUB_PATH | |
| - name: Report versions | |
| run: | | |
| rustup --version | |
| rustc -Vv | |
| - name: Verify mdbook-spec lockfile is current | |
| working-directory: ./mdbook-spec | |
| run: cargo update -p mdbook-spec --locked | |
| - name: Test mdbook-spec | |
| working-directory: ./mdbook-spec | |
| run: cargo test | |
| - name: Rustfmt check | |
| working-directory: ./mdbook-spec | |
| run: cargo fmt --check | |
| preview: | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@master | |
| - name: Checkout rust-lang/rust | |
| uses: actions/checkout@master | |
| with: | |
| repository: rust-lang/rust | |
| path: rust | |
| - name: Update rustup | |
| run: rustup self update | |
| - name: Install Rust | |
| run: | | |
| rustup set profile minimal | |
| rustup toolchain install nightly | |
| rustup default nightly | |
| - name: Install mdbook | |
| run: | | |
| mkdir bin | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$(pwd)/bin" >> $GITHUB_PATH | |
| - name: Build the book | |
| env: | |
| SPEC_RELATIVE: 0 | |
| SPEC_RUST_ROOT: ${{ github.workspace }}/rust | |
| run: mdbook build --dest-dir dist/preview-${{ github.event.pull_request.number }} | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: preview-${{ github.event.pull_request.number }} | |
| overwrite: true | |
| path: dist | |
| # The success job is here to consolidate the total success/failure state of | |
| # all other jobs. This job is then included in the GitHub branch protection | |
| # rule which prevents merges unless all other jobs are passing. This makes | |
| # it easier to manage the list of jobs via this yml file and to prevent | |
| # accidentally adding new jobs without also updating the branch protections. | |
| success: | |
| name: Success gate | |
| if: always() | |
| needs: | |
| - code-tests | |
| - style-tests | |
| - mdbook-spec | |
| # preview is explicitly excluded here since it doesn't run on merge | |
| runs-on: ubuntu-latest | |
| steps: | |
| - run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}' | |
| - name: Done | |
| run: exit 0 |