✨ Merge pull request #29 from shyim/main

Add cache key setting
JetBrains · Dec 28, 2021 · d88382a · d88382a
2 parents ef23511 + f149f4b
commit d88382a
Show file tree

Hide file tree

Showing 9 changed files with 2,558 additions and 2,539 deletions.
diff --git a/README.md b/README.md
@@ -99,6 +99,7 @@ You can set up [GitHub code scanning](https://docs.github.com/en/code-security/c
 | `profile-path`             | Absolute path to the profile file. Optional.                                                                                       | -                                       |
 | `upload-result`            | Upload Qodana results as an artifact to the job. Optional.                                                                         | `true`                                  |
 | `use-caches`               | Utilize GitHub caches for Qodana runs. Optional.                                                                                   | `true`                                  |
+| `additional-cache-hash`    | Allows customizing the generated cache hash. Optional.                                                                             |                                         |
 | `use-annotations`          | Use annotation to mark the results in the GitHub user interface. Optional.                                                         | `true`                                  |
 | `github-token`             | GitHub token to be used for uploading results. Optional.                                                                           | `${{ github.token }}`                   |
 

diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -63,6 +63,7 @@ function inputsDefaultFixture(): Inputs {
     projectDir: '${{ github.workspace }}',
     resultsDir: '${{ runner.temp }}/qodana-results',
     cacheDir: '${{ runner.temp }}/qodana-caches',
+    additionalCacheHash: '',
     additionalVolumes: [],
     additionalEnvVars: [],
     inspectedDir: '',

diff --git a/action.yaml b/action.yaml
@@ -21,6 +21,10 @@ inputs:
     description: 'Directory to store Qodana caches'
     required: false
     default: "${{ runner.temp }}/qodana/caches"
+  additional-cache-hash:
+    description: 'Pass additional cache hash extension'
+    required: false
+    default: "${{ github.sha }}"
   idea-config-dir:
     description: 'IntelliJ IDEA configuration directory'
     required: false

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "qodana-action",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Qodana is a code quality monitoring tool that identifies bugs, duplications, and imperfections.",
   "main": "lib/main.js",
   "scripts": {

diff --git a/src/context.ts b/src/context.ts
@@ -8,6 +8,7 @@ export interface Inputs {
   projectDir: string
   resultsDir: string
   cacheDir: string
+  additionalCacheHash: string
   additionalVolumes: string[]
   additionalEnvVars: string[]
   inspectedDir: string
@@ -36,6 +37,7 @@ export function getInputs(): Inputs {
     projectDir: core.getInput('project-dir'),
     resultsDir: core.getInput('results-dir'),
     cacheDir: core.getInput('cache-dir'),
+    additionalCacheHash: core.getInput('additional-cache-hash'),
     additionalVolumes: core.getMultilineInput('additional-volumes'),
     additionalEnvVars: core.getMultilineInput('additional-env-variables'),
     inspectedDir: core.getInput('inspected-dir'),

diff --git a/src/main.ts b/src/main.ts
@@ -32,7 +32,7 @@ async function main(): Promise<void> {
     await io.mkdirP(inputs.resultsDir)
 
     if (inputs.useCaches) {
-      await restoreCaches(inputs.cacheDir)
+      await restoreCaches(inputs.cacheDir, inputs.additionalCacheHash)
     }
 
     const args = getQodanaRunArgs(inputs)
@@ -52,7 +52,7 @@ async function main(): Promise<void> {
     const failedByThreshold = isFailedByThreshold(dockerExec.exitCode)
     if (isExecutionSuccessful(dockerExec.exitCode)) {
       if (inputs.useCaches) {
-        await uploadCaches(inputs.cacheDir)
+        await uploadCaches(inputs.cacheDir, inputs.additionalCacheHash)
       }
 
       if (inputs.useAnnotations) {

diff --git a/src/utils.ts b/src/utils.ts
@@ -52,15 +52,19 @@ export function validateContext(inputs: Inputs): Inputs {
 /**
  * Restores the cache from GitHub Actions cache to the given path.
  * @param cacheDir The path to restore the cache to.
+ * @param additionalCacheHash Addition to the generated cache hash
  */
-export async function restoreCaches(cacheDir: string): Promise<void> {
+export async function restoreCaches(
+  cacheDir: string,
+  additionalCacheHash: string
+): Promise<void> {
   try {
     await cache.restoreCache(
       [cacheDir],
-      `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}`,
+      `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}${additionalCacheHash}`,
       [
-        `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}-`,
-        `${process.env['RUNNER_OS']}-qodana-`
+        `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}-${additionalCacheHash}`,
+        `${process.env['RUNNER_OS']}-qodana-${additionalCacheHash}`
       ]
     )
   } catch (error) {
@@ -71,12 +75,16 @@ export async function restoreCaches(cacheDir: string): Promise<void> {
 /**
  * Uploads the cache to GitHub Actions cache from the given path.
  * @param cacheDir The path to upload the cache from.
+ * @param additionalCacheHash Addition to the generated cache hash
  */
-export async function uploadCaches(cacheDir: string): Promise<void> {
+export async function uploadCaches(
+  cacheDir: string,
+  additionalCacheHash: string
+): Promise<void> {
   try {
     await cache.saveCache(
       [cacheDir],
-      `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}-${process.env['GITHUB_SHA']}`
+      `${process.env['RUNNER_OS']}-qodana-${process.env['GITHUB_REF']}-${additionalCacheHash}`
     )
   } catch (error) {
     core.warning(`Failed to upload caches – ${(error as Error).message}`)