about summary refs log tree commit diff
path: root/tools
diff options
context:
space:
mode:
authorsterni <sternenseemann@systemli.org>2022-02-03T13·50+0100
committerclbot <clbot@tvl.fyi>2022-02-04T11·22+0000
commit66055161fba70df2a79429a40978a589e94c7ac6 (patch)
treedf98587dc15631623e48b8795f262e1e98650095 /tools
parent5d064256556a6af2e90a7c902c166ab67c65ea3a (diff)
feat(tools/rust-crates-advisory): omit GHFM checklist in buildkite r/3763
Buildkite doesn't understand GitHub Flavored Markdown and having a read
only checklist in there is probably not much use.

Change-Id: I41538487087e8c817b1a5e653f077bb0fbe6eb47
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5201
Reviewed-by: sterni <sternenseemann@systemli.org>
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: sterni <sternenseemann@systemli.org>
Tested-by: BuildkiteCI
Diffstat (limited to 'tools')
-rw-r--r--tools/rust-crates-advisory/default.nix3
-rw-r--r--tools/rust-crates-advisory/format-audit-result.jq4
2 files changed, 6 insertions, 1 deletions
diff --git a/tools/rust-crates-advisory/default.nix b/tools/rust-crates-advisory/default.nix
index ac190173627d..8382ec25435b 100644
--- a/tools/rust-crates-advisory/default.nix
+++ b/tools/rust-crates-advisory/default.nix
@@ -175,6 +175,9 @@ let
       "--arg"
       "maintainers"
       ""
+      "--argjson"
+      "checklist"
+      "false"
       "-f"
       ./format-audit-result.jq
     ]
diff --git a/tools/rust-crates-advisory/format-audit-result.jq b/tools/rust-crates-advisory/format-audit-result.jq
index 6f230df3f9b0..7c9e3cbac71b 100644
--- a/tools/rust-crates-advisory/format-audit-result.jq
+++ b/tools/rust-crates-advisory/format-audit-result.jq
@@ -9,6 +9,8 @@
 #   for the current lock file.
 # - attr: An attribute name (or otherwise unique identifier) to associate the
 #   report for the current lock file with.
+# - checklist: If true, the markdown report will use GHFM checklists for the
+#   report, allowing to tick of attributes as taken care of.
 
 # Link to human-readable advisory info for a given vulnerability
 def link:
@@ -62,7 +64,7 @@ def format_vulnerability:
 if .vulnerabilities.found | not then
   ""
 else
-  ([ "- [ ] "
+  ([ "-", if $checklist then " [ ] " else " " end
    , "`", $attr, "`: "
    , (.vulnerabilities.count | tostring)
    , " vulnerabilities in Cargo.lock"