Add an encapsulated file stream in axum-extra to make it more conveni… #5089
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 | |
env: | |
CARGO_TERM_COLOR: always | |
MSRV: '1.75' | |
on: | |
push: | |
branches: | |
- main | |
pull_request: {} | |
jobs: | |
check: | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: taiki-e/install-action@protoc | |
- uses: dtolnay/rust-toolchain@beta | |
with: | |
components: clippy, rustfmt | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Check | |
run: cargo clippy --workspace --all-targets --all-features -- -D warnings | |
- name: rustfmt | |
run: cargo fmt --all --check | |
check-docs: | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@stable | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: cargo doc | |
env: | |
RUSTDOCFLAGS: "-D rustdoc::all -A rustdoc::private-doc-tests" | |
run: cargo doc --all-features --no-deps | |
cargo-hack: | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: taiki-e/install-action@protoc | |
- uses: dtolnay/rust-toolchain@stable | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Install cargo-hack | |
run: | | |
curl -LsSf https://github.com/taiki-e/cargo-hack/releases/latest/download/cargo-hack-x86_64-unknown-linux-gnu.tar.gz | tar xzf - -C ~/.cargo/bin | |
- name: cargo hack check | |
run: cargo hack check --each-feature --no-dev-deps --all | |
cargo-public-api-crates: | |
runs-on: ubuntu-24.04 | |
strategy: | |
matrix: | |
crate: [axum, axum-core, axum-extra, axum-macros] | |
steps: | |
- uses: actions/checkout@v4 | |
# Pinned version due to failing `cargo-public-api-crates`. | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: nightly-2024-06-06 | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Install cargo-public-api-crates | |
run: | | |
cargo install --git https://github.com/davidpdrsn/cargo-public-api-crates | |
- name: Build rustdoc | |
run: | | |
cargo rustdoc --all-features --manifest-path ${{ matrix.crate }}/Cargo.toml -- -Z unstable-options --output-format json | |
- name: cargo public-api-crates check | |
run: cargo public-api-crates --manifest-path ${{ matrix.crate }}/Cargo.toml --skip-build check | |
test-versions: | |
needs: check | |
runs-on: ubuntu-24.04 | |
strategy: | |
matrix: | |
rust: [stable, beta] | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: taiki-e/install-action@protoc | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ matrix.rust }} | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Run tests | |
run: cargo test --workspace --all-features --all-targets | |
# some examples don't support our MSRV so we only test axum itself on our MSRV | |
test-nightly: | |
needs: check | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Get rust-toolchain version | |
id: rust-toolchain | |
run: echo "version=$(cat axum-macros/rust-toolchain)" >> $GITHUB_OUTPUT | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ steps.rust-toolchain.outputs.version }} | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Run nightly tests | |
working-directory: axum-macros | |
run: cargo test | |
# some examples don't support our MSRV (such as async-graphql) | |
# so we only test axum itself on our MSRV | |
test-msrv: | |
needs: check | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ env.MSRV }} | |
- name: "install Rust nightly" | |
uses: dtolnay/rust-toolchain@nightly | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Select minimal version | |
run: cargo +nightly update -Z minimal-versions | |
- name: Fix up Cargo.lock | |
run: cargo +nightly update -p crc32fast --precise 1.1.1 | |
- name: Run tests | |
run: > | |
cargo +${{ env.MSRV }} | |
test | |
-p axum | |
-p axum-extra | |
-p axum-core | |
--all-features | |
--locked | |
# the compiler errors are different on our MSRV which makes | |
# the trybuild tests in axum-macros fail, so just run the doc | |
# tests | |
- name: Run axum-macros doc tests | |
run: > | |
cargo +${{ env.MSRV }} | |
test | |
-p axum-macros | |
--doc | |
--all-features | |
--locked | |
test-docs: | |
needs: check | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@stable | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Run doc tests | |
run: cargo test --all-features --doc | |
deny-check: | |
name: cargo-deny check | |
runs-on: ubuntu-24.04 | |
continue-on-error: ${{ matrix.checks == 'advisories' }} | |
strategy: | |
matrix: | |
checks: | |
- advisories | |
- bans licenses sources | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: EmbarkStudios/cargo-deny-action@v1 | |
with: | |
command: check ${{ matrix.checks }} | |
manifest-path: axum/Cargo.toml | |
armv5te-unknown-linux-musleabi: | |
needs: check | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@stable | |
with: | |
target: armv5te-unknown-linux-musleabi | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Check | |
env: | |
# Clang has native cross-compilation support | |
CC: clang | |
run: > | |
cargo | |
check | |
--all-targets | |
--all-features | |
-p axum | |
-p axum-core | |
-p axum-extra | |
-p axum-macros | |
--target armv5te-unknown-linux-musleabi | |
wasm32-unknown-unknown: | |
needs: check | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@stable | |
with: | |
target: wasm32-unknown-unknown | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Check | |
run: > | |
cargo | |
check | |
--manifest-path ./examples/simple-router-wasm/Cargo.toml | |
--target wasm32-unknown-unknown | |
dependencies-are-sorted: | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dtolnay/rust-toolchain@beta | |
- uses: Swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
prefix-key: "v0-rust-ubuntu-24.04" | |
- name: Install cargo-sort | |
run: | | |
cargo install cargo-sort | |
# Work around cargo-sort not honoring workspace.exclude | |
- name: Remove non-crate folder | |
run: rm -rf examples/async-graphql | |
- name: Check dependency tables | |
run: | | |
cargo sort --workspace --grouped --check | |
typos: | |
name: Spell Check with Typos | |
runs-on: ubuntu-24.04 | |
if: github.event_name == 'push' || !github.event.pull_request.draft | |
steps: | |
- name: Checkout Actions Repository | |
uses: actions/checkout@v4 | |
- name: Check the spelling of the files in our repo | |
uses: crate-ci/[email protected] |