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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# This is the main CI workflow that runs the test suite on all pushes to main and all pull requests.
# It runs the following jobs:
# - required: runs the test suite on ubuntu with stable and beta rust toolchains
# - minimal: runs the test suite with the minimal versions of the dependencies that satisfy the requirements of this crate, and its dependencies
# - os-check: runs the test suite on Mac and Windows
# - coverage: runs the test suite and collects coverage information
# See check.yml for information about how the concurrency cancellation and workflow triggering work
name: test
env:
RUST_LOG: ${{ vars.RUST_LOG }}
permissions:
contents: read
on:
push:
branches:
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
required:
name: ubuntu / ${{ matrix.toolchain }}
runs-on: ubuntu-latest
strategy:
matrix:
# run on stable and beta to ensure that tests won't break on the next version of the rust
toolchain:
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Install ${{ matrix.toolchain }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.toolchain }}
# enable this ci template to run regardless of whether the lockfile is checked in or not
- name: cargo generate-lockfile
if: hashFiles('Cargo.lock') == ''
run: cargo generate-lockfile
- name: cargo install nextest
uses: taiki-e/install-action@nextest
- run: cargo nextest run --locked --workspace --all-features --all-targets
# Nextest currently [doesn't support doctests](https://github.com/nextest-rs/nextest/issues/16)
# For `cargo test`, there's an issue that [cargo test --all-targets does not run doc tests](https://github.com/rust-lang/cargo/issues/6669)
- run: cargo test --doc --locked --workspace --all-features
# This action chooses the oldest version of the dependencies permitted by Cargo.toml
# to ensure that this crate is compatible with the minimal version that this crate and its dependencies require.
# This will pick up issues where this crate relies on functionality that was introduced later
# than the actual version specified (e.g., when we choose just a major version, but a method was added after this version).
# This particular check can be difficult to get to succeed as often transitive dependencies may be incorrectly specified
# (e.g., a dependency specifies 1.0 but really requires 1.1.5).
# There is an alternative flag available `-Zdirect-minimal-versions` that uses the minimal versions for direct dependencies of this crate,
# while selecting the maximal versions for the transitive dependencies.
#
# Alternatively, you can add a line in your Cargo.toml to artificially increase the minimal dependency,
# which you do with e.g.:
# ```toml
# # for minimal-versions
# [target.'cfg(any())'.dependencies]
# openssl = { version = "0.10.55", optional = true } # needed to allow foo to build with `-Zminimal-versions
# ```
# The optional = true is necessary in case that dependency isn't otherwise transitively required
# by your library, and the target bit is so that this dependency edge never actually affects Cargo build order.
# See also <https://github.com/jonhoo/fantoccini/blob/fde336472b712bc7ebf5b4e772023a7ba71b2262/Cargo.toml#L47-L49>
# This action is run on ubuntu with the stable toolchain, as it is not expected to fail
minimal:
runs-on: ubuntu-latest
name: ubuntu / stable / minimal-versions
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@stable
- name: Install nightly, to run with flag -Zminimal-versions
uses: dtolnay/rust-toolchain@nightly
- name: rustup default stable
run: rustup default stable
- name: cargo update -Zminimal-versions
run: cargo +nightly update -Zminimal-versions
- name: cargo install nextest
uses: taiki-e/install-action@nextest
- name: cargo nextest run
run: cargo nextest run --locked --workspace --all-features --all-targets
# run cargo test on Mac and Windows
os-check:
runs-on: ${{ matrix.os }}
name: ${{ matrix.os }} / stable
strategy:
fail-fast: false
matrix:
os:
steps:
# if your project needs OpenSSL, uncomment this to fix Windows builds.
# it's commented out by default as the installation command takes 5-10m.
#
# - run: echo "VCPKG_ROOT=$env:VCPKG_INSTALLATION_ROOT" | Out-File -FilePath $env:GITHUB_ENV -Append
# if: runner.os == 'Windows'
# - run: vcpkg install openssl:x64-windows-static-md
# if: runner.os == 'Windows'
- uses: actions/checkout@v4
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@stable
- name: cargo generate-lockfile
if: hashFiles('Cargo.lock') == ''
run: cargo generate-lockfile
- name: cargo install nextest
uses: taiki-e/install-action@nextest
- name: cargo nextest run
run: cargo nextest run --workspace --locked --all-features --all-targets
coverage:
# Use llvm-cov to build and collect coverage and outputs in a format that is compatible with codecov.io.
#
# Note that codecov as of v4 requires that CODECOV_TOKEN from:
# https://app.codecov.io/gh/<user or org>/<project>/settings
#
# This is set in two places on your repo:
# - https://github.com/jonhoo/guardian/settings/secrets/actions
# - https://github.com/jonhoo/guardian/settings/secrets/dependabot
# (the former is necessary for codecov uploads to work with Dependabot PRs)
#
# PRs coming from forks of your repo will not have access to the token,
# but for those, codecov allows uploading coverage reports without a token.
# It's all a little weird and inconvenient.
# See <https://github.com/codecov/feedback/issues/112> for lots of more discussion
runs-on: ubuntu-latest
name: ubuntu / stable / coverage
steps:
- uses: actions/checkout@v4
with:
submodules: true
# use nightly to use the `coverage(off))` attribute
- name: Install nightly
uses: dtolnay/rust-toolchain@nightly
with:
components: llvm-tools-preview
- name: cargo generate-lockfile
if: hashFiles('Cargo.lock') == ''
run: cargo generate-lockfile
- name: cargo install nextest
uses: taiki-e/install-action@nextest
- name: cargo install cargo-llvm-cov
uses: taiki-e/install-action@cargo-llvm-cov
# Use nextest as default.
# You can use `--codecov` to use region coverage, but [the way Codecov shows region/branch coverage is not very good.](https://github.com/taiki-e/cargo-llvm-cov/pull/255#issuecomment-1513318191)
- name: cargo llvm-cov nextest
run: cargo llvm-cov nextest --locked --workspace --all-features --lcov --output-path lcov.info
- name: Record Rust version
run: echo "RUST=$(rustc --version)" >> "$GITHUB_ENV"
- name: Upload to codecov.io
uses: codecov/codecov-action@v4
with:
files: "lcov.info"
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
env_vars: OS,RUST