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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# This workflow runs whenever a PR is opened or updated, or a commit is pushed to main. It runs
# several checks:
# - fmt: checks that the code is formatted according to rustfmt
# - clippy: checks that the code does not contain any clippy warnings
# - doc: checks that the code can be documented without errors
# - hack: check combinations of feature flags
# - msrv: check that the msrv specified in the crate is correct
permissions:
contents: read
# This configuration allows maintainers of this repo to create a branch and pull request based on
# the new branch. Restricting the push trigger to the main branch ensures that the PR only gets
# built once.
on:
push:
branches: [main, main-nextgen]
pull_request:
# If new code is pushed to a PR branch, then cancel in progress workflows for that PR. Ensures that
# we don't waste CI time, and returns results quicker https://github.com/jonhoo/rust-ci-conf/pull/5
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
name: check
jobs:
fmt:
runs-on: ubuntu-latest
name: nightly / fmt
strategy:
fail-fast: false
matrix:
workdir: [ ".", "examples",]
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install nightly
uses: dtolnay/rust-toolchain@nightly
with:
components: rustfmt
targets: thumbv8m.main-none-eabihf
- name: cargo fmt --check
run: cargo fmt --check
working-directory: ${{ matrix.workdir }}
clippy-examples:
runs-on: ubuntu-latest
name: ${{ matrix.toolchain }} / clippy
permissions:
contents: read
checks: write
strategy:
fail-fast: false
matrix:
# Get early warning of new lints which are regularly introduced in beta channels.
toolchain: [stable]
workdir: ["examples"]
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install ${{ matrix.toolchain }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.toolchain }}
components: clippy
targets: thumbv8m.main-none-eabihf
- name: cargo clippy
working-directory: ${{ matrix.workdir }}
run: |
cargo clippy --locked -- -Dwarnings -D clippy::suspicious -D clippy::correctness -D clippy::perf -D clippy::style
# Enable once we have a released crate
# semver:
# runs-on: ubuntu-latest
# name: semver
# steps:
# - uses: actions/checkout@v6
# with:
# submodules: true
# - name: Install stable
# uses: dtolnay/rust-toolchain@stable
# with:
# components: rustfmt
# - name: cargo-semver-checks
# uses: obi1kenobi/cargo-semver-checks-action@v2
doc:
# run docs generation on nightly rather than stable. This enables features like
# https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an
# API be documented as only available in some specific platforms.
runs-on: ubuntu-latest
name: nightly / doc
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install nightly
uses: dtolnay/rust-toolchain@nightly
with:
targets: thumbv8m.main-none-eabihf
- name: cargo doc
run: |
cargo doc --no-deps --all-features --locked
env:
RUSTDOCFLAGS: --cfg docsrs
hack:
# cargo-hack checks combinations of feature flags to ensure that features are all additive
# which is required for feature unification
runs-on: ubuntu-latest
name: ubuntu / stable / features
strategy:
fail-fast: false
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
components: clippy
targets: thumbv8m.main-none-eabihf
- name: cargo install cargo-hack
uses: taiki-e/install-action@cargo-hack
- name: cargo hack
run: cargo hack --feature-powerset check
deny:
# cargo-deny checks licenses, advisories, sources, and bans for
# our dependencies.
runs-on: ubuntu-latest
name: ubuntu / stable / deny
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@stable
with:
targets: thumbv8m.main-none-eabihf
- name: cargo install cargo-deny
uses: EmbarkStudios/cargo-deny-action@v2
with:
log-level: warn
manifest-path: ./Cargo.toml
command: check
arguments: --all-features --locked
msrv:
# check that we can build using the minimal rust version that is specified by this crate
runs-on: ubuntu-latest
# we use a matrix here just because env can't be used in job names
# https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability
strategy:
fail-fast: false
matrix:
msrv: ["1.91"] # We're relying on namespaced-features, which
# was released in 1.60
#
# We also depend on `fixed' which requires rust
# 1.71
#
# Additionally, we depend on embedded-hal-async
# which requires 1.75
#
# embassy-time requires 1.79 due to
# collapse_debuginfo
#
# embassy upstream switched to rust 1.85
#
# unsigned_is_multiple_of requires 1.90, else we get clippy warnings
#
# [email protected] requires rustc 1.91
name: ubuntu / ${{ matrix.msrv }}
steps:
- uses: actions/checkout@v6
with:
submodules: true
- name: Install ${{ matrix.msrv }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.msrv }}
targets: thumbv8m.main-none-eabihf
- name: cargo +${{ matrix.msrv }} check
run: |
cargo check --all-features --locked
|
