Skip to content

Commit 5e18af8

Browse files
authored
Merge pull request #548 from godot-rust/feature/ci-deny-machete
CI: add `cargo-deny` and `cargo-machete`
2 parents 13af9d6 + 83e02d7 commit 5e18af8

File tree

7 files changed

+350
-41
lines changed

7 files changed

+350
-41
lines changed

.github/other/deny.toml

Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,289 @@
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+
# If 1 or more target triples (and optionally, target_features) are specified,
15+
# only the specified targets will be checked when running `cargo deny check`.
16+
# This means, if a particular package is only ever used as a target specific
17+
# dependency, such as, for example, the `nix` crate only being used via the
18+
# `target_family = "unix"` configuration, that only having windows targets in
19+
# this list would mean the nix crate, as well as any of its exclusive
20+
# dependencies not shared by any other crates, would be ignored, as the target
21+
# list here is effectively saying which targets you are building for.
22+
targets = [
23+
# The triple can be any string, but only the target triples built in to
24+
# rustc (as of 1.40) can be checked against actual config expressions
25+
#{ triple = "x86_64-unknown-linux-musl" },
26+
# You can also specify which target_features you promise are enabled for a
27+
# particular target. target_features are currently not validated against
28+
# the actual valid features supported by the target architecture.
29+
#{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
30+
]
31+
# When creating the dependency graph used as the source of truth when checks are
32+
# executed, this field can be used to prune crates from the graph, removing them
33+
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
34+
# is pruned from the graph, all of its dependencies will also be pruned unless
35+
# they are connected to another crate in the graph that hasn't been pruned,
36+
# so it should be used with care. The identifiers are [Package ID Specifications]
37+
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
38+
#exclude = []
39+
# If true, metadata will be collected with `--all-features`. Note that this can't
40+
# be toggled off if true, if you want to conditionally enable `--all-features` it
41+
# is recommended to pass `--all-features` on the cmd line instead
42+
all-features = false
43+
# If true, metadata will be collected with `--no-default-features`. The same
44+
# caveat with `all-features` applies
45+
no-default-features = false
46+
# If set, these feature will be enabled when collecting metadata. If `--features`
47+
# is specified on the cmd line they will take precedence over this option.
48+
#features = []
49+
# When outputting inclusion graphs in diagnostics that include features, this
50+
# option can be used to specify the depth at which feature edges will be added.
51+
# This option is included since the graphs can be quite large and the addition
52+
# of features from the crate(s) to all of the graph roots can be far too verbose.
53+
# This option can be overridden via `--feature-depth` on the cmd line
54+
feature-depth = 1
55+
56+
# This section is considered when running `cargo deny check advisories`
57+
# More documentation for the advisories section can be found here:
58+
# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
59+
[advisories]
60+
# The path where the advisory database is cloned/fetched into
61+
db-path = "~/.cargo/advisory-db"
62+
# The url(s) of the advisory databases to use
63+
db-urls = ["https://github.com/rustsec/advisory-db"]
64+
# The lint level for security vulnerabilities
65+
vulnerability = "deny"
66+
# The lint level for unmaintained crates
67+
unmaintained = "deny"
68+
# The lint level for crates that have been yanked from their source registry
69+
yanked = "deny"
70+
# The lint level for crates with security notices. Note that as of
71+
# 2019-12-17 there are no security notice advisories in
72+
# https://github.com/rustsec/advisory-db
73+
notice = "warn"
74+
# A list of advisory IDs to ignore. Note that ignored advisories will still
75+
# output a note when they are encountered.
76+
ignore = [
77+
#"RUSTSEC-0000-0000",
78+
]
79+
# Threshold for security vulnerabilities, any vulnerability with a CVSS score
80+
# lower than the range specified will be ignored. Note that ignored advisories
81+
# will still output a note when they are encountered.
82+
# * None - CVSS Score 0.0
83+
# * Low - CVSS Score 0.1 - 3.9
84+
# * Medium - CVSS Score 4.0 - 6.9
85+
# * High - CVSS Score 7.0 - 8.9
86+
# * Critical - CVSS Score 9.0 - 10.0
87+
#severity-threshold =
88+
89+
# If this is true, then cargo deny will use the git executable to fetch advisory database.
90+
# If this is false, then it uses a built-in git library.
91+
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
92+
# See Git Authentication for more information about setting up git authentication.
93+
#git-fetch-with-cli = true
94+
95+
# This section is considered when running `cargo deny check licenses`
96+
# More documentation for the licenses section can be found here:
97+
# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
98+
[licenses]
99+
# The lint level for crates which do not have a detectable license
100+
unlicensed = "deny"
101+
# List of explicitly allowed licenses
102+
# See https://spdx.org/licenses/ for list of possible licenses
103+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
104+
allow = [
105+
"MIT",
106+
"Apache-2.0",
107+
"Zlib",
108+
"BSD-3-Clause",
109+
"ISC",
110+
"Unicode-DFS-2016",
111+
"MPL-2.0",
112+
#"Apache-2.0 WITH LLVM-exception",
113+
]
114+
# List of explicitly disallowed licenses
115+
# See https://spdx.org/licenses/ for list of possible licenses
116+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
117+
deny = [
118+
#"Nokia",
119+
]
120+
# Lint level for licenses considered copyleft
121+
copyleft = "deny"
122+
# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
123+
# * both - The license will be approved if it is both OSI-approved *AND* FSF
124+
# * either - The license will be approved if it is either OSI-approved *OR* FSF
125+
# * osi - The license will be approved if it is OSI approved
126+
# * fsf - The license will be approved if it is FSF Free
127+
# * osi-only - The license will be approved if it is OSI-approved *AND NOT* FSF
128+
# * fsf-only - The license will be approved if it is FSF *AND NOT* OSI-approved
129+
# * neither - This predicate is ignored and the default lint level is used
130+
allow-osi-fsf-free = "neither"
131+
# Lint level used when no other predicates are matched
132+
# 1. License isn't in the allow or deny lists
133+
# 2. License isn't copyleft
134+
# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
135+
default = "deny"
136+
# The confidence threshold for detecting a license from license text.
137+
# The higher the value, the more closely the license text must be to the
138+
# canonical license text of a valid SPDX license file.
139+
# [possible values: any between 0.0 and 1.0].
140+
confidence-threshold = 0.8
141+
# Allow 1 or more licenses on a per-crate basis, so that particular licenses
142+
# aren't accepted for every possible crate as with the normal allow list
143+
exceptions = [
144+
# Each entry is the crate and version constraint, and its specific allow
145+
# list
146+
#{ allow = ["Zlib"], name = "adler32", version = "*" },
147+
]
148+
149+
# Some crates don't have (easily) machine readable licensing information,
150+
# adding a clarification entry for it allows you to manually specify the
151+
# licensing information
152+
#[[licenses.clarify]]
153+
# The name of the crate the clarification applies to
154+
#name = "ring"
155+
# The optional version constraint for the crate
156+
#version = "*"
157+
# The SPDX expression for the license requirements of the crate
158+
#expression = "MIT AND ISC AND OpenSSL"
159+
# One or more files in the crate's source used as the "source of truth" for
160+
# the license expression. If the contents match, the clarification will be used
161+
# when running the license check, otherwise the clarification will be ignored
162+
# and the crate will be checked normally, which may produce warnings or errors
163+
# depending on the rest of your configuration
164+
#license-files = [
165+
# Each entry is a crate relative path, and the (opaque) hash of its contents
166+
#{ path = "LICENSE", hash = 0xbd0eed23 }
167+
#]
168+
169+
[licenses.private]
170+
# If true, ignores workspace crates that aren't published, or are only
171+
# published to private registries.
172+
# To see how to mark a crate as unpublished (to the official registry),
173+
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
174+
ignore = false
175+
# One or more private registries that you might publish crates to, if a crate
176+
# is only published to private registries, and ignore is true, the crate will
177+
# not have its license(s) checked
178+
registries = [
179+
#"https://sekretz.com/registry
180+
]
181+
182+
# This section is considered when running `cargo deny check bans`.
183+
# More documentation about the 'bans' section can be found here:
184+
# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
185+
[bans]
186+
# Lint level for when multiple versions of the same crate are detected
187+
multiple-versions = "warn"
188+
# Lint level for when a crate version requirement is `*`
189+
wildcards = "allow"
190+
# The graph highlighting used when creating dotgraphs for crates
191+
# with multiple versions
192+
# * lowest-version - The path to the lowest versioned duplicate is highlighted
193+
# * simplest-path - The path to the version with the fewest edges is highlighted
194+
# * all - Both lowest-version and simplest-path are used
195+
highlight = "all"
196+
# The default lint level for `default` features for crates that are members of
197+
# the workspace that is being checked. This can be overridden by allowing/denying
198+
# `default` on a crate-by-crate basis if desired.
199+
workspace-default-features = "allow"
200+
# The default lint level for `default` features for external crates that are not
201+
# members of the workspace. This can be overridden by allowing/denying `default`
202+
# on a crate-by-crate basis if desired.
203+
external-default-features = "allow"
204+
# List of crates that are allowed. Use with care!
205+
allow = [
206+
#{ name = "ansi_term", version = "=0.11.0" },
207+
]
208+
# List of crates to deny
209+
# Each entry the name of a crate and a version range. If version is
210+
# not specified, all versions will be matched.
211+
#{ name = "ansi_term", version = "=0.11.0" },
212+
#
213+
# Wrapper crates can optionally be specified to allow the crate when it
214+
# is a direct dependency of the otherwise banned crate
215+
#{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
216+
#
217+
# See also: https://togithub.com/RustSec/advisory-db/issues/173
218+
deny = [
219+
# unmaintained since Feb 20 + https://github.com/noamtashma/owning-ref-unsoundness
220+
{ name = "owning_ref" },
221+
222+
# unmaintained since Jul 20, RustSec refuses to acknowledge "because author says maintained"
223+
# https://togithub.com/rustsec/advisory-db/pull/891
224+
{ name = "im" },
225+
{ name = "im-rc" },
226+
227+
# Too heavy in default setup. Can be included for custom-godot etc.
228+
{ name = "syn", wrappers = ["bindgen", "gensym"] },
229+
{ name = "serde", wrappers = ["godot-core", "serde_json"] },
230+
]
231+
232+
# List of features to allow/deny
233+
# Each entry the name of a crate and a version range. If version is
234+
# not specified, all versions will be matched.
235+
#[[bans.features]]
236+
#name = "reqwest"
237+
# Features to not allow
238+
#deny = ["json"]
239+
# Features to allow
240+
#allow = [
241+
# "rustls",
242+
# "__rustls",
243+
# "__tls",
244+
# "hyper-rustls",
245+
# "rustls",
246+
# "rustls-pemfile",
247+
# "rustls-tls-webpki-roots",
248+
# "tokio-rustls",
249+
# "webpki-roots",
250+
#]
251+
# If true, the allowed features must exactly match the enabled feature set. If
252+
# this is set there is no point setting `deny`
253+
#exact = true
254+
255+
# Certain crates/versions that will be skipped when doing duplicate detection.
256+
skip = [
257+
#{ name = "ansi_term", version = "=0.11.0" },
258+
]
259+
# Similarly to `skip` allows you to skip certain crates during duplicate
260+
# detection. Unlike skip, it also includes the entire tree of transitive
261+
# dependencies starting at the specified crate, up to a certain depth, which is
262+
# by default infinite.
263+
skip-tree = [
264+
#{ name = "ansi_term", version = "=0.11.0", depth = 20 },
265+
]
266+
267+
# This section is considered when running `cargo deny check sources`.
268+
# More documentation about the 'sources' section can be found here:
269+
# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
270+
[sources]
271+
# Lint level for what to happen when a crate from a crate registry that is not
272+
# in the allow list is encountered
273+
unknown-registry = "deny"
274+
# Lint level for what to happen when a crate from a git repository that is not
275+
# in the allow list is encountered
276+
unknown-git = "deny"
277+
# List of URLs for allowed crate registries. Defaults to the crates.io index
278+
# if not specified. If it is specified but empty, no registries are allowed.
279+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
280+
# List of URLs for allowed Git repositories
281+
allow-git = []
282+
283+
[sources.allow-org]
284+
# 1 or more github.com organizations to allow git sources for
285+
github = ["godot-rust"]
286+
# 1 or more gitlab.com organizations to allow git sources for
287+
#gitlab = [""]
288+
# 1 or more bitbucket.org organizations to allow git sources for
289+
#bitbucket = [""]

0 commit comments

Comments
 (0)