Allow to disable caching completely (#351)

* Add skip-cache parameter

* Update README

* Implement cache skipping

* Run prettier

* update descriptions

* re-build dist

Co-authored-by: Sergey Vilgelm <sergey@vilgelm.com>

Author: tdabasinskas

README.md

@@ -55,6 +55,10 @@ jobs:
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true
 
+          # Optional: if set to true then the all caching functionality will be complete disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true
+
           # Optional: if set to true then the action don't cache or restore ~/go/pkg.
           # skip-pkg-cache: true
 

action.yml

@@ -20,6 +20,12 @@ inputs:
     description: "if set to true and the action runs on a pull request - the action outputs only newly found issues"
     default: false
     required: true
+  skip-cache:
+    description: |
+      if set to true then the all caching functionality will be complete disabled,
+      takes precedence over all other caching options.
+    default: false
+    required: true
   skip-pkg-cache:
     description: "if set to true then the action doesn't cache or restore ~/go/pkg."
     default: false

dist/post_run/index.js

@@ -65066,6 +65066,8 @@ function buildCacheKeys() {
 }
 function restoreCache() {
     return __awaiter(this, void 0, void 0, function* () {
+        if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+            return;
         if (!utils.isValidEvent()) {
             utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
             return;
@@ -65104,6 +65106,8 @@ function restoreCache() {
 exports.restoreCache = restoreCache;
 function saveCache() {
     return __awaiter(this, void 0, void 0, function* () {
+        if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+            return;
         // Validate inputs, this can cause task failure
         if (!utils.isValidEvent()) {
             utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);

dist/run/index.js

@@ -65066,6 +65066,8 @@ function buildCacheKeys() {
 }
 function restoreCache() {
     return __awaiter(this, void 0, void 0, function* () {
+        if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+            return;
         if (!utils.isValidEvent()) {
             utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
             return;
@@ -65104,6 +65106,8 @@ function restoreCache() {
 exports.restoreCache = restoreCache;
 function saveCache() {
     return __awaiter(this, void 0, void 0, function* () {
+        if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+            return;
         // Validate inputs, this can cause task failure
         if (!utils.isValidEvent()) {
             utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);

src/cache.ts

@@ -72,6 +72,8 @@ async function buildCacheKeys(): Promise<string[]> {
 }
 
 export async function restoreCache(): Promise<void> {
+  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+
   if (!utils.isValidEvent()) {
     utils.logWarning(
       `Event Validation Error: The event type ${process.env[Events.Key]} is not supported because it's not tied to a branch or tag ref.`
@@ -112,6 +114,8 @@ export async function restoreCache(): Promise<void> {
 }
 
 export async function saveCache(): Promise<void> {
+  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+
   // Validate inputs, this can cause task failure
   if (!utils.isValidEvent()) {
     utils.logWarning(