Publish docs to GitHub pages on release only (#2516) #2949
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: | |
| branches: | |
| - '*' | |
| push: | |
| branches: | |
| - master | |
| defaults: | |
| run: | |
| shell: bash | |
| env: | |
| RUSTFLAGS: --deny warnings | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Clippy | |
| run: cargo clippy --all --all-targets | |
| - name: Format | |
| run: cargo fmt --all -- --check | |
| - name: Install Dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install ripgrep shellcheck | |
| - name: Check for Forbidden Words | |
| run: ./bin/forbid | |
| - name: Check Install Script | |
| run: shellcheck www/install.sh | |
| pages: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install `mdbook` | |
| run: cargo install mdbook | |
| - name: Install `mdbook-linkcheck` | |
| run: | | |
| mkdir -p mdbook-linkcheck | |
| cd mdbook-linkcheck | |
| wget https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip | |
| unzip mdbook-linkcheck.x86_64-unknown-linux-gnu.zip | |
| chmod +x mdbook-linkcheck | |
| pwd >> $GITHUB_PATH | |
| - name: Build book | |
| run: | | |
| cargo run --package generate-book | |
| mdbook build book/en | |
| mdbook build book/zh | |
| test: | |
| strategy: | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| - macos-latest | |
| - windows-latest | |
| runs-on: ${{matrix.os}} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Remove Broken WSL bash executable | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| shell: cmd | |
| run: | | |
| takeown /F C:\Windows\System32\bash.exe | |
| icacls C:\Windows\System32\bash.exe /grant administrators:F | |
| del C:\Windows\System32\bash.exe | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Test | |
| run: cargo test --all | |
| - name: Test install.sh | |
| run: | | |
| bash www/install.sh --to /tmp --tag 1.25.0 | |
| /tmp/just --version |