From 0a99159c6af65aaa79496745a9ededc9afd87d2c Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Tue, 18 Oct 2022 03:05:24 -0400
Subject: [PATCH] fix(docs): license setup command clarification [skip ci]

---
 source/plugins/licenses/examples.yml | 4 ++--
 source/plugins/licenses/metadata.yml | 5 ++++-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/source/plugins/licenses/examples.yml b/source/plugins/licenses/examples.yml
index 2395fb3c..64bfbf88 100644
--- a/source/plugins/licenses/examples.yml
+++ b/source/plugins/licenses/examples.yml
@@ -6,7 +6,7 @@
     template: repository
     repo: metrics
     plugin_licenses: yes
-    plugin_licenses_setup: npm ci
+    plugin_licenses_setup: "[[ -f package.json ]] && npm ci || true"
   test:
     timeout: 1800000
     modes:
@@ -21,7 +21,7 @@
     template: repository
     repo: metrics
     plugin_licenses: yes
-    plugin_licenses_setup: npm ci
+    plugin_licenses_setup: "[[ -f package.json ]] && npm ci || true"
     plugin_licenses_legal: no
     plugin_licenses_ratio: yes
   test:
diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml
index fcd0ba5c..baab4d04 100644
--- a/source/plugins/licenses/metadata.yml
+++ b/source/plugins/licenses/metadata.yml
@@ -32,9 +32,12 @@ inputs:
   plugin_licenses_setup:
     description: |
       Setup command
+
+      > ℹ️ Depending on the project, this may not be required.
+      > The example command is intended for NodeJs projects that use `npm` to install their dependencies.
     type: string
     default: ""
-    example: npm ci
+    example: "[[ -f package.json ]] && npm ci || true"
 
   plugin_licenses_ratio:
     description: |