1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# This file is for the main tests. clippy & rustfmt are separate workflows
on:
name: Cargo Test
env:
CARGO_TERM_COLOR: always
# has a history of occasional bugs (especially on old versions)
#
# the ci is free so we might as well use it ;)
CARGO_INCREMENTAL: 0
# Tested versions:
# 1. stable
# 2. nightly
# 3. Minimum Supported Rust Version (MSRV)
jobs:
test:
# Only run on PRs if the source branch is on someone else's repo
if: ${{ github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name }}
runs-on: ubuntu-latest
strategy:
fail-fast: false # Even if one job fails we still want to see the other ones
matrix:
rust:
# Minimum Supported Rust Version
#
# This is hardcoded and needs to be in sync with Cargo.toml and the README
- 1.31
# Intermediate Releases (between MSRV and latest stable)
# Be careful not to add these needlessly; they hold up CI
- 1.61
# The most recent version of stable rust (automatically updated)
- stable
- nightly
# NOTE: Features to test must be specified manually. They are applied to all versions separately.
#
# This has the advantage of being more flexible and thorough
# This has the disadvantage of being more verbose
#
# Specific feature combos can be overridden per-version with 'include' and 'ecclude'
features:
- ""
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
- uses: Swatinem/rust-cache@v2
if: ${{ matrix.rust != 'nightly' }} # ineffective due to version key
with:
# On old versions, it takes a long time to update the registry
# Focus on caching that, which should be fine even on failure
cache-on-failure: true
cache-targets: false
cache-bin: false
- uses: taiki-e/install-action@v2
with:
tool: cargo-minimal-versions,cargo-hack
- name: Check
# NOTE: Does not run with --all-targets due to dev-dependencies requiring recent rust
run: |
cargo check --verbose --no-default-features --features "${{ matrix.features }}"
# A failing `cargo check` always fails the build
continue-on-error: false
- name: Test
# Restrict to running on stable, as dev-dependencies require recent rust versions
# and nightly can change the compiler output
if: ${{ matrix.rust == 'stable' }}
# NOTE: Running --all-targets does not include doc tests
run: |
cargo test --all --verbose --no-default-features --features "${{ matrix.features }}"
# We require tests to succeed on all the feature combinations.
#
# However, we can grant special exceptions for the Minimum Supported Rust Version
# if there is a really good reason (like a dependency that requires a newer version).
continue-on-error: false
- name: Test (-Zminimal-versions)
# Same rationale as restricting tests to stable
if: ${{ matrix.rust == 'stable' }}
# NOTE: Use of --all here means features must be defined for the entire workspace
# Since the default package is the only published package, the flag is not strictly necessary
run: |
cargo minimal-versions test --verbose --no-default-features --features "${{ matrix.features }}"
- name: rustdoc
# Restrict to working on nightly/stable (old versions might have undefined types)
if: ${{ matrix.rust == 'nightly' || matrix.rust == 'stable' }}
env:
RUSTDOCFLAGS: -Dwarnings
run: |
cargo doc --no-deps --all --verbose --no-default-features --features "${{ matrix.features }}"
# Runs the same build that docs.rs does. See https://github.com/dtolnay/cargo-docs-rs
docsrs:
# Only run on PRs if the source branch is on someone else's repo
if: ${{ github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name }}
name: docs.rs
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: -Dwarnings
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@nightly
- uses: dtolnay/install@cargo-docs-rs
- run: cargo docs-rs