🚸 Add a tip about results uploading on GitHub

JetBrains · Jun 20, 2023 · e6ca5c0 · e6ca5c0
1 parent 2cb4011
commit e6ca5c0
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 2 deletions.
diff --git a/scan/__tests__/main.test.ts b/scan/__tests__/main.test.ts
@@ -198,6 +198,15 @@ To be able to view the detailed Qodana report, you can either:
   3. Host [Qodana report at GitHub Pages](https://github.com/JetBrains/qodana-action/blob/3a8e25f5caad8d8b01c1435f1ef7b19fe8b039a0/README.md#github-pages)
   4. Inspect and use \`qodana.sarif.json\` (see [the Qodana SARIF format](https://www.jetbrains.com/help/qodana/qodana-sarif-output.html#Report+structure) for details)
 
+To get \`*.log\` files or any other Qodana artifacts, run the action with \`upload-result\` option set to \`true\`, 
+so that the action will upload the files as the job artifacts:
+\`\`\`yaml
+      - name: 'Qodana Scan'
+        uses: JetBrains/qodana-action@v2023.1.5
+        with:
+          upload-result: true
+\`\`\`
+
 </details>
 
 <details>

diff --git a/scan/dist/index.js b/scan/dist/index.js
@@ -63719,6 +63719,15 @@ var require_output = __commonJS({
   2. Use [GitHub Code Scanning with Qodana](https://github.com/jetbrains/qodana-action#github-code-scanning)
   3. Host [Qodana report at GitHub Pages](https://github.com/JetBrains/qodana-action/blob/3a8e25f5caad8d8b01c1435f1ef7b19fe8b039a0/README.md#github-pages)
   4. Inspect and use \`qodana.sarif.json\` (see [the Qodana SARIF format](https://www.jetbrains.com/help/qodana/qodana-sarif-output.html#Report+structure) for details)
+
+To get \`*.log\` files or any other Qodana artifacts, run the action with \`upload-result\` option set to \`true\`, 
+so that the action will upload the files as the job artifacts:
+\`\`\`yaml
+      - name: 'Qodana Scan'
+        uses: JetBrains/qodana-action@v${qodana_12.VERSION}
+        with:
+          upload-result: true
+\`\`\`
 `;
     var SUMMARY_PR_MODE = `\u{1F4A1} Qodana analysis was run in the pull request mode: only the changed files were checked`;
     function publishOutput(failedByThreshold, resultsDir, useAnnotations, postComment, execute) {

diff --git a/scan/src/output.ts b/scan/src/output.ts
@@ -5,7 +5,8 @@ import {
   QODANA_LICENSES_JSON,
   QODANA_LICENSES_MD,
   QODANA_REPORT_URL_NAME,
-  QODANA_SARIF_NAME
+  QODANA_SARIF_NAME,
+  VERSION
 } from '../../common/qodana'
 import {
   ANALYSIS_FINISHED_REACTION,
@@ -35,6 +36,15 @@ const VIEW_REPORT_OPTIONS = `To be able to view the detailed Qodana report, you
   2. Use [GitHub Code Scanning with Qodana](https://github.com/jetbrains/qodana-action#github-code-scanning)
   3. Host [Qodana report at GitHub Pages](https://github.com/JetBrains/qodana-action/blob/3a8e25f5caad8d8b01c1435f1ef7b19fe8b039a0/README.md#github-pages)
   4. Inspect and use \`qodana.sarif.json\` (see [the Qodana SARIF format](https://www.jetbrains.com/help/qodana/qodana-sarif-output.html#Report+structure) for details)
+
+To get \`*.log\` files or any other Qodana artifacts, run the action with \`upload-result\` option set to \`true\`, 
+so that the action will upload the files as the job artifacts:
+\`\`\`yaml
+      - name: 'Qodana Scan'
+        uses: JetBrains/qodana-action@v${VERSION}
+        with:
+          upload-result: true
+\`\`\`
 `
 const SUMMARY_PR_MODE = `💡 Qodana analysis was run in the pull request mode: only the changed files were checked`
 

diff --git a/scan/src/utils.ts b/scan/src/utils.ts
@@ -33,7 +33,7 @@ const REACTIONS = [
   'rocket',
   'eyes'
 ] as const
-type Reaction = typeof REACTIONS[number]
+type Reaction = (typeof REACTIONS)[number]
 
 /**
  * The context for the action.