🐛 Limit dependencies list in GitHub commit if it's too large (QD-9677)

JetBrains · Aug 6, 2024 · 21595cb · 21595cb
1 parent d273417
commit 21595cb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/scan/dist/index.js b/scan/dist/index.js
@@ -134513,6 +134513,7 @@ so that the action will upload the files as the job artifacts:
 \`\`\`
 `;
     var SUMMARY_PR_MODE = `\u{1F4A1} Qodana analysis was run in the pull request mode: only the changed files were checked`;
+    var DEPENDENCY_CHARS_LIMIT = 65e3;
     function wrapToDiffBlock(message) {
       return `\`\`\`diff
 ${message}
@@ -134625,7 +134626,7 @@ ${body}
     function getSummary(toolName, projectDir, annotations, coverageInfo, packages, licensesInfo, reportUrl, prMode) {
       const contactBlock = wrapToToggleBlock("Contact Qodana team", SUMMARY_MISC);
       let licensesBlock = "";
-      if (licensesInfo !== "") {
+      if (licensesInfo !== "" && licensesInfo.length < DEPENDENCY_CHARS_LIMIT) {
         licensesBlock = wrapToToggleBlock(`Detected ${packages} ${getDepencencyPlural(packages)}`, licensesInfo);
       }
       let prModeBlock = "";

diff --git a/scan/src/output.ts b/scan/src/output.ts
@@ -69,6 +69,7 @@ so that the action will upload the files as the job artifacts:
 \`\`\`
 `
 const SUMMARY_PR_MODE = `💡 Qodana analysis was run in the pull request mode: only the changed files were checked`
+const DEPENDENCY_CHARS_LIMIT = 65000 // 65k chars is the GitHub limit for a comment
 
 function wrapToDiffBlock(message: string): string {
   return `\`\`\`diff
@@ -262,7 +263,7 @@ export function getSummary(
 ): string {
   const contactBlock = wrapToToggleBlock('Contact Qodana team', SUMMARY_MISC)
   let licensesBlock = ''
-  if (licensesInfo !== '') {
+  if (licensesInfo !== '' && licensesInfo.length < DEPENDENCY_CHARS_LIMIT) {
     licensesBlock = wrapToToggleBlock(
       `Detected ${packages} ${getDepencencyPlural(packages)}`,
       licensesInfo