name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
env:
RUST_BACKTRACE: 1
CARGO_TERM_COLOR: always
jobs:
test:
name: Test (${{ matrix.os }}, ${{ matrix.rust }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
rust: [stable, beta]
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
- name: Cache cargo registry
uses: actions/cache@v5
with:
path: ~/.cargo/registry
key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
- name: Cache cargo index
uses: actions/cache@v5
with:
path: ~/.cargo/git
key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}
- name: Cache target directory
uses: actions/cache@v5
with:
path: target
key: ${{ runner.os }}-${{ matrix.rust }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}
- name: Run tests
run: cargo test --all-features --verbose
- name: Run tests (no default features)
run: cargo test --no-default-features --verbose
- name: Build documentation
run: cargo doc --no-deps --all-features
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- name: Check formatting
run: cargo fmt --all -- --check
- name: Run clippy
run: cargo clippy --all-targets --all-features -- -D warnings
msrv:
name: Check MSRV (1.87)
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: "1.87"
- name: Check build with MSRV
run: cargo check --all-features
example-snapshots:
name: Example Snapshot Check
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Build jemdoc-rs
run: cargo build --release
- name: Regenerate example HTML
working-directory: example
run: ../target/release/jemdoc-rs -c mysite.conf *.jemdoc
- name: Check for snapshot drift
run: |
git diff --exit-code -- example/*.html || {
echo ""
echo "Example HTML is out of date. Regenerate with:"
echo " cd example && jemdoc-rs -c mysite.conf *.jemdoc"
exit 1
}
publish-dry-run:
name: Publish Dry Run
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Verify package
run: cargo publish --dry-run