add knip reports check to CI (#930)

04kash · web-flow · commit f1c6aeb4da1e · 2025-06-17T11:32:54.000-04:00
Signed-off-by: Kashish Mittal &lt;kmittal@redhat.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -92,6 +92,24 @@ jobs:
 
       - name: prettier
         run: yarn prettier:check
+      
+      - name: read knip-reports flag from bcp.json
+        id: bcp
+        run: |
+          echo "Checking for bcp.json in workspace: workspaces/${{ matrix.workspace }}"
+          if [ -f bcp.json ]; then
+            echo "Reading knip-reports flag..."
+            KNIP_REPORTS=$(jq -r '.["knip-reports"]' bcp.json)
+            echo "knip-reports value: $KNIP_REPORTS"
+            echo "knip_reports=$KNIP_REPORTS" >> $GITHUB_OUTPUT
+          else
+            echo "bcp.json not found. Defaulting knip_reports to false."
+            echo "knip_reports=false" >> $GITHUB_OUTPUT
+          fi
+          
+      - name: check knip reports
+        if: ${{ steps.bcp.outputs.knip_reports == 'true' }}
+        run: yarn build:knip-reports --ci
 
       - name: check api reports and generate API reference
         run: yarn build:api-reports:only --ci
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,6 +31,7 @@ The `redhat-developer/rhdh-plugins` repository is designed as a collaborative sp
       - [Types of PRs](#types-of-prs)
         - [Dependency Updates](#dependency-updates)
         - [Security Fixes](#security-fixes)
+    - [Opt-in to Knip Reports Check](#opt-in-to-knip-reports-check)
 
 ## License
 
@@ -325,3 +326,8 @@ This repository uses [Renovate](https://docs.renovatebot.com/) to automatically
 
 - PRs can also be opened for security alerts. These PRs are distinguishable with a `[security]`suffix in its title and will also have a `security` label.
 
+### Opt-in to Knip Reports Check
+
+Plugin owners can opt in to Knip reports check in CI by creating a `bcp.json` file in the root of their workspace (`workspaces/${WORKSPACE}/.auto-version-bump`) and adding `"knip-reports": true`. This ensures that knip reports in your workspace stay up to date.
+
+[Knip](https://knip.dev/) is a tool that helps with clean-up and maintenance by identifying unused dependencies within workspaces. Regularly reviewing and addressing these reports can significantly improve code quality and reduce bloat.
diff --git a/workspaces/adoption-insights/package.json b/workspaces/adoption-insights/package.json
@@ -15,6 +15,7 @@
     "build:api-reports": "yarn build:api-reports:only",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
     "build-image": "yarn workspace backend build-image",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/ai-integrations/package.json b/workspaces/ai-integrations/package.json
@@ -16,6 +16,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/bulk-import/package.json b/workspaces/bulk-import/package.json
@@ -12,6 +12,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/global-floating-action-button/package.json b/workspaces/global-floating-action-button/package.json
@@ -12,6 +12,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/global-header/package.json b/workspaces/global-header/package.json
@@ -15,6 +15,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/homepage/package.json b/workspaces/homepage/package.json
@@ -15,6 +15,7 @@
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
     "build-image": "yarn workspace backend build-image",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/lightspeed/package.json b/workspaces/lightspeed/package.json
@@ -15,6 +15,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/marketplace/package.json b/workspaces/marketplace/package.json
@@ -16,6 +16,7 @@
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
     "build-image": "yarn workspace backend build-image",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test --detectOpenHandles",
     "test:all": "backstage-cli repo test --coverage --detectOpenHandles",
diff --git a/workspaces/noop/package.json b/workspaces/noop/package.json
@@ -7,6 +7,7 @@
   "scripts": {
     "backstage-cli": "exit 0",
     "build:api-reports:only": "exit 0",
+    "build:knip-reports": "exit 0",
     "fix": "exit 0",
     "postinstall": "cd ../../ && yarn install",
     "prettier:check": "exit 0",
diff --git a/workspaces/openshift-image-registry/package.json b/workspaces/openshift-image-registry/package.json
@@ -12,6 +12,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/orchestrator/package.json b/workspaces/orchestrator/package.json
@@ -13,6 +13,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only",
     "build:api-reports:only": "backstage-repo-tools api-reports --allow-all-warnings -o ae-wrong-input-file-type --validate-release-tags --exclude 'plugins/orchestrator-swf-editor-envelope'",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/repo-tools/package.json b/workspaces/repo-tools/package.json
@@ -24,6 +24,7 @@
     "new": "backstage-cli new --scope internal",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "postinstall": "cd ../../ && yarn install"
   },
   "prettier": "@spotify/prettier-config",
diff --git a/workspaces/repo-tools/packages/cli/src/lib/workspaces/templates/workspace/package.json.hbs b/workspaces/repo-tools/packages/cli/src/lib/workspaces/templates/workspace/package.json.hbs
@@ -11,6 +11,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/sandbox/package.json b/workspaces/sandbox/package.json
@@ -15,6 +15,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
     "test:all": "backstage-cli repo test --coverage",
diff --git a/workspaces/theme/package.json b/workspaces/theme/package.json
@@ -14,6 +14,7 @@
     "build:all": "backstage-cli repo build --all",
     "build:api-reports": "yarn build:api-reports:only --tsc",
     "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-missing-release-tag,ae-undocumented --validate-release-tags",
+    "build:knip-reports": "backstage-repo-tools knip-reports",
     "build-image": "yarn workspace backend build-image",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
