Add a retention period of 7 days

For debug artifacts. Ensures they don't stick around too long since these can be large.
github · Jan 10, 2024 · f5a8218 · f5a8218
1 parent 3b54300
commit f5a8218
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the
 
 ## [UNRELEASED]
 
-No user facing changes.
+- Change the retention period for uploaded debug artifacts to 7 days. Previously, this was whatever the repository default was. [#2079](https://github.com/github/codeql-action/pull/2079)
 
 ## 3.23.0 - 08 Jan 2024
 

diff --git a/lib/debug-artifacts.js b/lib/debug-artifacts.js
diff --git a/lib/debug-artifacts.js.map b/lib/debug-artifacts.js.map
diff --git a/src/debug-artifacts.ts b/src/debug-artifacts.ts
@@ -49,7 +49,11 @@ export async function uploadDebugArtifacts(
     sanitizeArifactName(`${artifactName}${suffix}`),
     toUpload.map((file) => path.normalize(file)),
     path.normalize(rootDir),
-    { continueOnError: true },
+    {
+      continueOnError: true,
+      // ensure we don't keep the debug artifacts around for too long since they can be large.
+      retentionDays: 7,
+    },
   );
 }