Skip to content

Commit 885a5e4

Browse files
ci/nightly: Add license checks via cargo deny
Check that all used dependencies are compatible with out current license. The deny.toml is automatically generated by "cargo deny init" Signed-off-by: Tomás González <tomasagustin.gonzalezorlando@arm.com>
1 parent 5a94528 commit 885a5e4

File tree

2 files changed

+242
-0
lines changed

2 files changed

+242
-0
lines changed

.github/workflows/nightly.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,10 @@ jobs:
4343
run: cargo install cargo-audit
4444
- name: Execute cargo audit
4545
run: cargo audit
46+
47+
cargo-deny:
48+
name: "Run cargo deny"
49+
runs-on: ubuntu-latest
50+
steps:
51+
- uses: actions/checkout@v3
52+
- uses: EmbarkStudios/cargo-deny-action@v1

deny.toml

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
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+
#"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
76+
#{ crate = "a-crate-that-is-yanked@0.1.1", 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+
#"MIT",
93+
#"Apache-2.0",
94+
#"Apache-2.0 WITH LLVM-exception",
95+
]
96+
# The confidence threshold for detecting a license from license text.
97+
# The higher the value, the more closely the license text must be to the
98+
# canonical license text of a valid SPDX license file.
99+
# [possible values: any between 0.0 and 1.0].
100+
confidence-threshold = 0.8
101+
# Allow 1 or more licenses on a per-crate basis, so that particular licenses
102+
# aren't accepted for every possible crate as with the normal allow list
103+
exceptions = [
104+
# Each entry is the crate and version constraint, and its specific allow
105+
# list
106+
#{ allow = ["Zlib"], crate = "adler32" },
107+
]
108+
109+
# Some crates don't have (easily) machine readable licensing information,
110+
# adding a clarification entry for it allows you to manually specify the
111+
# licensing information
112+
#[[licenses.clarify]]
113+
# The package spec the clarification applies to
114+
#crate = "ring"
115+
# The SPDX expression for the license requirements of the crate
116+
#expression = "MIT AND ISC AND OpenSSL"
117+
# One or more files in the crate's source used as the "source of truth" for
118+
# the license expression. If the contents match, the clarification will be used
119+
# when running the license check, otherwise the clarification will be ignored
120+
# and the crate will be checked normally, which may produce warnings or errors
121+
# depending on the rest of your configuration
122+
#license-files = [
123+
# Each entry is a crate relative path, and the (opaque) hash of its contents
124+
#{ path = "LICENSE", hash = 0xbd0eed23 }
125+
#]
126+
127+
[licenses.private]
128+
# If true, ignores workspace crates that aren't published, or are only
129+
# published to private registries.
130+
# To see how to mark a crate as unpublished (to the official registry),
131+
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
132+
ignore = false
133+
# One or more private registries that you might publish crates to, if a crate
134+
# is only published to private registries, and ignore is true, the crate will
135+
# not have its license(s) checked
136+
registries = [
137+
#"https://sekretz.com/registry
138+
]
139+
140+
# This section is considered when running `cargo deny check bans`.
141+
# More documentation about the 'bans' section can be found here:
142+
# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
143+
[bans]
144+
# Lint level for when multiple versions of the same crate are detected
145+
multiple-versions = "warn"
146+
# Lint level for when a crate version requirement is `*`
147+
wildcards = "allow"
148+
# The graph highlighting used when creating dotgraphs for crates
149+
# with multiple versions
150+
# * lowest-version - The path to the lowest versioned duplicate is highlighted
151+
# * simplest-path - The path to the version with the fewest edges is highlighted
152+
# * all - Both lowest-version and simplest-path are used
153+
highlight = "all"
154+
# The default lint level for `default` features for crates that are members of
155+
# the workspace that is being checked. This can be overridden by allowing/denying
156+
# `default` on a crate-by-crate basis if desired.
157+
workspace-default-features = "allow"
158+
# The default lint level for `default` features for external crates that are not
159+
# members of the workspace. This can be overridden by allowing/denying `default`
160+
# on a crate-by-crate basis if desired.
161+
external-default-features = "allow"
162+
# List of crates that are allowed. Use with care!
163+
allow = [
164+
#"ansi_term@0.11.0",
165+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
166+
]
167+
# List of crates to deny
168+
deny = [
169+
#"ansi_term@0.11.0",
170+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
171+
# Wrapper crates can optionally be specified to allow the crate when it
172+
# is a direct dependency of the otherwise banned crate
173+
#{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
174+
]
175+
176+
# List of features to allow/deny
177+
# Each entry the name of a crate and a version range. If version is
178+
# not specified, all versions will be matched.
179+
#[[bans.features]]
180+
#crate = "reqwest"
181+
# Features to not allow
182+
#deny = ["json"]
183+
# Features to allow
184+
#allow = [
185+
# "rustls",
186+
# "__rustls",
187+
# "__tls",
188+
# "hyper-rustls",
189+
# "rustls",
190+
# "rustls-pemfile",
191+
# "rustls-tls-webpki-roots",
192+
# "tokio-rustls",
193+
# "webpki-roots",
194+
#]
195+
# If true, the allowed features must exactly match the enabled feature set. If
196+
# this is set there is no point setting `deny`
197+
#exact = true
198+
199+
# Certain crates/versions that will be skipped when doing duplicate detection.
200+
skip = [
201+
#"ansi_term@0.11.0",
202+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
203+
]
204+
# Similarly to `skip` allows you to skip certain crates during duplicate
205+
# detection. Unlike skip, it also includes the entire tree of transitive
206+
# dependencies starting at the specified crate, up to a certain depth, which is
207+
# by default infinite.
208+
skip-tree = [
209+
#"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
210+
#{ crate = "ansi_term@0.11.0", depth = 20 },
211+
]
212+
213+
# This section is considered when running `cargo deny check sources`.
214+
# More documentation about the 'sources' section can be found here:
215+
# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
216+
[sources]
217+
# Lint level for what to happen when a crate from a crate registry that is not
218+
# in the allow list is encountered
219+
unknown-registry = "warn"
220+
# Lint level for what to happen when a crate from a git repository that is not
221+
# in the allow list is encountered
222+
unknown-git = "warn"
223+
# List of URLs for allowed crate registries. Defaults to the crates.io index
224+
# if not specified. If it is specified but empty, no registries are allowed.
225+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
226+
# List of URLs for allowed Git repositories
227+
allow-git = []
228+
229+
[sources.allow-org]
230+
# 1 or more github.com organizations to allow git sources for
231+
github = [""]
232+
# 1 or more gitlab.com organizations to allow git sources for
233+
gitlab = [""]
234+
# 1 or more bitbucket.org organizations to allow git sources for
235+
bitbucket = [""]

0 commit comments

Comments
 (0)