Skip to content

Commit 9a7cdef

Browse files
committed
build: introduce deny rules (licenses, versions,...)
1 parent 2ae7a36 commit 9a7cdef

File tree

7 files changed

+276
-11
lines changed

7 files changed

+276
-11
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ jobs:
3131
- run: just check
3232
- run: just lint
3333
- run: just test
34+
- run: just deny
3435
#- run: just test_each_feature
3536
- run: ${SCCACHE_PATH} --show-stats
3637
shell: bash

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ opentelemetry-otlp = { version = "0.25", default-features = false }
4343
opentelemetry-proto = { version = "0.25", default-features = false }
4444
opentelemetry-stdout = { version = "0.25" }
4545
rstest = "0.22"
46-
tokio = { version = "1.38", default-features = false }
46+
tokio = { version = "1", default-features = false }
4747
tokio-stream = { version = "0.1", default-features = false }
4848
tonic = { version = "0.12", default-features = false } #should be sync with opentelemetry-proto
4949
tower = { version = "0.5", default-features = false }

deny.toml

Lines changed: 253 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,253 @@
1+
# This template contains all of the possible sections and their default values
2+
3+
# Note that all fields that take a lint level have these possible values:
4+
# * deny - An error will be produced and the check will fail
5+
# * warn - A warning will be produced, but the check will not fail
6+
# * allow - No warning or error will be produced, though in some cases a note
7+
# will be
8+
9+
# The values provided in this template are the default values that will be used
10+
# when any section or field is not specified in your own configuration
11+
12+
# Root options
13+
14+
# The graph table configures how the dependency graph is constructed and thus
15+
# which crates the checks are performed against
16+
[graph]
17+
# If 1 or more target triples (and optionally, target_features) are specified,
18+
# only the specified targets will be checked when running `cargo deny check`.
19+
# This means, if a particular package is only ever used as a target specific
20+
# dependency, such as, for example, the `nix` crate only being used via the
21+
# `target_family = "unix"` configuration, that only having windows targets in
22+
# this list would mean the nix crate, as well as any of its exclusive
23+
# dependencies not shared by any other crates, would be ignored, as the target
24+
# list here is effectively saying which targets you are building for.
25+
targets = [
26+
# The triple can be any string, but only the target triples built in to
27+
# rustc (as of 1.40) can be checked against actual config expressions
28+
#"x86_64-unknown-linux-musl",
29+
# You can also specify which target_features you promise are enabled for a
30+
# particular target. target_features are currently not validated against
31+
# the actual valid features supported by the target architecture.
32+
#{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
33+
]
34+
# When creating the dependency graph used as the source of truth when checks are
35+
# executed, this field can be used to prune crates from the graph, removing them
36+
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
37+
# is pruned from the graph, all of its dependencies will also be pruned unless
38+
# they are connected to another crate in the graph that hasn't been pruned,
39+
# so it should be used with care. The identifiers are [Package ID Specifications]
40+
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
41+
#exclude = []
42+
# If true, metadata will be collected with `--all-features`. Note that this can't
43+
# be toggled off if true, if you want to conditionally enable `--all-features` it
44+
# is recommended to pass `--all-features` on the cmd line instead
45+
all-features = false
46+
# If true, metadata will be collected with `--no-default-features`. The same
47+
# caveat with `all-features` applies
48+
no-default-features = false
49+
# If set, these feature will be enabled when collecting metadata. If `--features`
50+
# is specified on the cmd line they will take precedence over this option.
51+
#features = []
52+
53+
# The output table provides options for how/if diagnostics are outputted
54+
[output]
55+
# When outputting inclusion graphs in diagnostics that include features, this
56+
# option can be used to specify the depth at which feature edges will be added.
57+
# This option is included since the graphs can be quite large and the addition
58+
# of features from the crate(s) to all of the graph roots can be far too verbose.
59+
# This option can be overridden via `--feature-depth` on the cmd line
60+
feature-depth = 1
61+
62+
# This section is considered when running `cargo deny check advisories`
63+
# More documentation for the advisories section can be found here:
64+
# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
65+
[advisories]
66+
# The path where the advisory databases are cloned/fetched into
67+
#db-path = "$CARGO_HOME/advisory-dbs"
68+
# The url(s) of the advisory databases to use
69+
#db-urls = ["https://github.com/rustsec/advisory-db"]
70+
# A list of advisory IDs to ignore. Note that ignored advisories will still
71+
# output a note when they are encountered.
72+
ignore = [
73+
#"RUSTSEC-0000-0000",
74+
#{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
75+
#"[email protected]", # you can also ignore yanked crate versions if you wish
76+
#{ crate = "[email protected]", reason = "you can specify why you are ignoring the yanked crate" },
77+
]
78+
# If this is true, then cargo deny will use the git executable to fetch advisory database.
79+
# If this is false, then it uses a built-in git library.
80+
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
81+
# See Git Authentication for more information about setting up git authentication.
82+
#git-fetch-with-cli = true
83+
84+
# This section is considered when running `cargo deny check licenses`
85+
# More documentation for the licenses section can be found here:
86+
# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
87+
[licenses]
88+
# List of explicitly allowed licenses
89+
# See https://spdx.org/licenses/ for list of possible licenses
90+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
91+
allow = [
92+
"Apache-2.0",
93+
"Apache-2.0 WITH LLVM-exception",
94+
"BSD-2-Clause",
95+
"BSD-3-Clause",
96+
"CC0-1.0",
97+
"ISC",
98+
"MIT",
99+
"OpenSSL",
100+
"Unicode-DFS-2016",
101+
"Unlicense",
102+
]
103+
# The confidence threshold for detecting a license from license text.
104+
# The higher the value, the more closely the license text must be to the
105+
# canonical license text of a valid SPDX license file.
106+
# [possible values: any between 0.0 and 1.0].
107+
confidence-threshold = 0.8
108+
# Allow 1 or more licenses on a per-crate basis, so that particular licenses
109+
# aren't accepted for every possible crate as with the normal allow list
110+
exceptions = [
111+
# Each entry is the crate and version constraint, and its specific allow
112+
# list
113+
#{ allow = ["Zlib"], crate = "adler32" },
114+
]
115+
116+
# Some crates don't have (easily) machine readable licensing information,
117+
# adding a clarification entry for it allows you to manually specify the
118+
# licensing information
119+
[[licenses.clarify]]
120+
# The package spec the clarification applies to
121+
crate = "ring"
122+
# The SPDX expression for the license requirements of the crate
123+
expression = "MIT AND ISC AND OpenSSL"
124+
license-files = [
125+
# Each entry is a crate relative path, and the (opaque) hash of its contents
126+
{ path = "LICENSE", hash = 0xbd0eed23 },
127+
]
128+
129+
[licenses.private]
130+
# One or more files in the crate's source used as the "source of truth" for
131+
# the license expression. If the contents match, the clarification will be used
132+
# when running the license check, otherwise the clarification will be ignored
133+
# and the crate will be checked normally, which may produce warnings or errors
134+
# depending on the rest of your configuration
135+
# If true, ignores workspace crates that aren't published, or are only
136+
# published to private registries.
137+
# To see how to mark a crate as unpublished (to the official registry),
138+
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
139+
ignore = false
140+
# One or more private registries that you might publish crates to, if a crate
141+
# is only published to private registries, and ignore is true, the crate will
142+
# not have its license(s) checked
143+
registries = [
144+
#"https://sekretz.com/registry
145+
]
146+
147+
# This section is considered when running `cargo deny check bans`.
148+
# More documentation about the 'bans' section can be found here:
149+
# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
150+
[bans]
151+
# Lint level for when multiple versions of the same crate are detected
152+
multiple-versions = "deny"
153+
# Lint level for when a crate version requirement is `*`
154+
wildcards = "allow"
155+
# The graph highlighting used when creating dotgraphs for crates
156+
# with multiple versions
157+
# * lowest-version - The path to the lowest versioned duplicate is highlighted
158+
# * simplest-path - The path to the version with the fewest edges is highlighted
159+
# * all - Both lowest-version and simplest-path are used
160+
highlight = "all"
161+
# The default lint level for `default` features for crates that are members of
162+
# the workspace that is being checked. This can be overridden by allowing/denying
163+
# `default` on a crate-by-crate basis if desired.
164+
workspace-default-features = "allow"
165+
# The default lint level for `default` features for external crates that are not
166+
# members of the workspace. This can be overridden by allowing/denying `default`
167+
# on a crate-by-crate basis if desired.
168+
external-default-features = "allow"
169+
# List of crates that are allowed. Use with care!
170+
allow = [
171+
172+
#{ crate = "[email protected]", reason = "you can specify a reason it is allowed" },
173+
]
174+
# List of crates to deny
175+
deny = [
176+
177+
#{ crate = "[email protected]", reason = "you can specify a reason it is banned" },
178+
# Wrapper crates can optionally be specified to allow the crate when it
179+
# is a direct dependency of the otherwise banned crate
180+
#{ crate = "[email protected]", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
181+
]
182+
183+
# List of features to allow/deny
184+
# Each entry the name of a crate and a version range. If version is
185+
# not specified, all versions will be matched.
186+
#[[bans.features]]
187+
#crate = "reqwest"
188+
# Features to not allow
189+
#deny = ["json"]
190+
# Features to allow
191+
#allow = [
192+
# "rustls",
193+
# "__rustls",
194+
# "__tls",
195+
# "hyper-rustls",
196+
# "rustls",
197+
# "rustls-pemfile",
198+
# "rustls-tls-webpki-roots",
199+
# "tokio-rustls",
200+
# "webpki-roots",
201+
#]
202+
# If true, the allowed features must exactly match the enabled feature set. If
203+
# this is set there is no point setting `deny`
204+
#exact = true
205+
206+
# Certain crates/versions that will be skipped when doing duplicate detection.
207+
skip = [
208+
209+
#{ crate = "[email protected]", reason = "you can specify a reason why it can't be updated/removed" },
210+
"[email protected]", # axum 0.7 use tower 0.5, but hyper still use 0.4
211+
"sync_wrapper", # axum direct and transive dependency use multiple version
212+
"regex-syntax",
213+
"regex-automata",
214+
"indexmap",
215+
"hermit-abi",
216+
"rustls-native-certs",
217+
"hashbrown",
218+
]
219+
# Similarly to `skip` allows you to skip certain crates during duplicate
220+
# detection. Unlike skip, it also includes the entire tree of transitive
221+
# dependencies starting at the specified crate, up to a certain depth, which is
222+
# by default infinite.
223+
skip-tree = [
224+
#"[email protected]", # will be skipped along with _all_ of its direct and transitive dependencies
225+
#{ crate = "[email protected]", depth = 20 },
226+
"windows-targets",
227+
"windows-sys",
228+
"async-std",
229+
]
230+
231+
# This section is considered when running `cargo deny check sources`.
232+
# More documentation about the 'sources' section can be found here:
233+
# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
234+
[sources]
235+
# Lint level for what to happen when a crate from a crate registry that is not
236+
# in the allow list is encountered
237+
unknown-registry = "warn"
238+
# Lint level for what to happen when a crate from a git repository that is not
239+
# in the allow list is encountered
240+
unknown-git = "warn"
241+
# List of URLs for allowed crate registries. Defaults to the crates.io index
242+
# if not specified. If it is specified but empty, no registries are allowed.
243+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
244+
# List of URLs for allowed Git repositories
245+
allow-git = []
246+
247+
[sources.allow-org]
248+
# github.com organizations to allow git sources for
249+
github = []
250+
# gitlab.com organizations to allow git sources for
251+
gitlab = []
252+
# bitbucket.org organizations to allow git sources for
253+
bitbucket = []

examples/axum-otlp/Cargo.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
[package]
22
name = "examples-axum-otlp"
3-
version = "0.19.0"
4-
edition = "2021"
53
publish = false
4+
edition.workspace = true
5+
version.workspace = true
6+
authors.workspace = true
7+
repository.workspace = true
8+
license.workspace = true
69

710
[dependencies]
811
axum = { workspace = true, default-features = true }

examples/grpc/Cargo.toml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
[package]
22
name = "examples-grpc"
3-
version = "0.15.0"
4-
edition = "2021"
53
publish = false
4+
edition.workspace = true
5+
version.workspace = true
6+
authors.workspace = true
7+
repository.workspace = true
8+
license.workspace = true
69

710
[dependencies]
811
init-tracing-opentelemetry = { path = "../../init-tracing-opentelemetry", features = [
@@ -19,7 +22,7 @@ tonic-reflection = "0.12"
1922
tonic-tracing-opentelemetry = { path = "../../tonic-tracing-opentelemetry" }
2023
tower = { workspace = true }
2124
tracing = { workspace = true }
22-
tracing-opentelemetry-instrumentation-sdk = "0.15" # { path = "../../tracing-opentelemetry-instrumentation-sdk" }
25+
tracing-opentelemetry-instrumentation-sdk = { path = "../../tracing-opentelemetry-instrumentation-sdk" }
2326

2427
[build-dependencies]
2528
tonic-build = "0.12"

examples/load/Cargo.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
[package]
22
name = "examples-load"
3-
version = "0.19.0"
4-
edition = "2021"
53
publish = false
4+
edition.workspace = true
5+
version.workspace = true
6+
authors.workspace = true
7+
repository.workspace = true
8+
license.workspace = true
69

710
[dependencies]
811
init-tracing-opentelemetry = { path = "../../init-tracing-opentelemetry", features = [

justfile

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ _install_cargo-binstall:
55
_binstall ARG: _install_cargo-binstall
66
@(cargo binstall -y {{ARG}} || cargo install --locked {{ARG}})
77

8+
_install_cargo-deny:
9+
@just _binstall cargo-deny
10+
811
_install_cargo-nextest:
912
@just _binstall cargo-nextest
1013

@@ -29,9 +32,8 @@ format:
2932
cargo fmt
3033
# cargo sort --workspace --grouped
3134

32-
deny:
33-
cargo deny check advisories
34-
cargo deny check bans licenses sources
35+
deny: _install_cargo-deny
36+
cargo deny check
3537

3638
check: _install_cargo-hack
3739
cargo hack check --each-feature --no-dev-deps

0 commit comments

Comments
 (0)