Enable caching by default with default input (#332)

actions · Mar 10, 2023 · c51a720 · c51a720
1 parent 6b848af
commit c51a720
Show file tree

Hide file tree

Showing 9 changed files with 167 additions and 6,269 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,16 @@ This action sets up a go environment for use in actions by:
 - Optionally downloading and caching a version of Go by version and adding to `PATH`.
 - Registering problem matchers for error output.
 
+# V4
+
+The V4 edition of the action offers:
+
+ - Enabled caching by default
+
+The action will try to enable caching unless the `cache` input is explicitly set to false.
+
+Please see "[Caching dependency files and build outputs](https://github.com/actions/setup-go#caching-dependency-files-and-build-outputs)" for more information.
+
 # V3
 
 The V3 edition of the action offers:
@@ -19,9 +29,14 @@ The V3 edition of the action offers:
 - stable and oldstable aliases
 - Bug Fixes (including issues around version matching and semver)
 
-The action will first check the local cache for a version match. If a version is not found locally, it will pull it from the `main` branch of the [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository. On miss or failure, it will fall back to downloading directly from [go dist](https://storage.googleapis.com/golang). To change the default behavior, please use the [check-latest input](#check-latest-version).
+The action will first check the local cache for a version match. If a version is not found locally, it will pull it from
+the `main` branch of the [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json)
+repository. On miss or failure, it will fall back to downloading directly
+from [go dist](https://storage.googleapis.com/golang). To change the default behavior, please use
+the [check-latest input](#check-latest-version).
 
-**Note:** The `setup-go` action uses executable binaries which are built by Golang side. The action does not build golang from source code.
+**Note:** The `setup-go` action uses executable binaries which are built by Golang side. The action does not build
+golang from source code.
 
 Matching by [semver spec](https://github.com/npm/node-semver):
 
@@ -78,14 +93,17 @@ steps:
   - run: go run hello.go
 ```
 
-
 ## Check latest version
 
-The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific Go version is always used.
+The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability
+and if you want to ensure a specific Go version is always used.
 
-If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a Go version will then be downloaded. Set `check-latest` to `true` if you want the most up-to-date Go version to always be used.
+If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally
+cached version is not the most up-to-date, a Go version will then be downloaded. Set `check-latest` to `true` if you
+want the most up-to-date Go version to always be used.
 
-> Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached versions.
+> Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached
+> versions.
 
 ```yaml
 steps:
@@ -99,11 +117,14 @@ steps:
 
 ## Using stable/oldstable aliases
 
-If `stable` is provided, action will get the latest stable version from the [`go-versions`](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository manifest. 
+If `stable` is provided, action will get the latest stable version from
+the [`go-versions`](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository manifest.
 
-If `oldstable` is provided, when current release is 1.19.x, action will resolve version as 1.18.x, where x is the latest patch release.
+If `oldstable` is provided, when current release is 1.19.x, action will resolve version as 1.18.x, where x is the latest
+patch release.
 
-**Note:** using these aliases will result in same version as using corresponding minor release with `check-latest` input set to `true`
+**Note:** using these aliases will result in same version as using corresponding minor release with `check-latest` input
+set to `true`
 
 ```yaml
 steps:
@@ -125,48 +146,47 @@ steps:
 
 ## Caching dependency files and build outputs:
 
-The action has a built-in functionality for caching and restoring go modules and build outputs. It uses [actions/cache](https://github.com/actions/cache) under the hood but requires less configuration settings. The `cache` input is optional, and caching is turned off by default.
+The action has a built-in functionality for caching and restoring go modules and build outputs. It
+uses [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood but requires less configuration settings.
+The `cache` input is optional, and caching is turned on by default.
 
-The action defaults to search for the dependency file - go.sum in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` input for cases when multiple dependency files are used, or they are located in different subdirectories.
+The action defaults to search for the dependency file - go.sum in the repository root, and uses its hash as a part of
+the cache key. Use `cache-dependency-path` input for cases when multiple dependency files are used, or they are located
+in different subdirectories.
 
-**Caching without specifying dependency file path**
-```yaml
-steps:
-  - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
-    with:
-      go-version: '1.17'
-      check-latest: true
-      cache: true
-  - run: go run hello.go
-```
+If some problem that prevents success caching happens then the action issues the warning in the log and continues the execution of the pipeline. 
 
 **Caching in monorepos**
+
 ```yaml
 steps:
   - uses: actions/checkout@v3
   - uses: actions/setup-go@v3
     with:
       go-version: '1.17'
       check-latest: true
-      cache: true
       cache-dependency-path: subdir/go.sum
   - run: go run hello.go
   ```
+
 ## Getting go version from the go.mod file
 
-The `go-version-file` input accepts a path to a `go.mod` file or a `go.work` file that contains the version of Go to be used by a project. As the `go.mod` file contains only major and minor (e.g. 1.18) tags, the action will search for the latest available patch version sequentially in the runner's directory with the cached tools, in the [versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go servers.
+The `go-version-file` input accepts a path to a `go.mod` file or a `go.work` file that contains the version of Go to be
+used by a project. As the `go.mod` file contains only major and minor (e.g. 1.18) tags, the action will search for the
+latest available patch version sequentially in the runner's directory with the cached tools, in
+the [versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go
+servers.
 
 If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used.
 > The action will search for the `go.mod` file relative to the repository root
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
-- uses: actions/setup-go@v3
-  with:
-    go-version-file: 'path/to/go.mod'
-- run: go version
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version-file: 'path/to/go.mod'
+  - run: go version
 ```
 
 ## Matrix testing
@@ -195,13 +215,23 @@ The `go-version` input supports the following syntax:
 - Specific versions: `1.15`, `1.16.1`, `1.17.0-rc.2`, `1.16.0-beta.1`
 - SemVer's version range syntax: `^1.13.1`, `>=1.18.0-rc.1`
 
-For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver) documentation.
+For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver)
+documentation.
 
 ## Using `setup-go` on GHES
 
-`setup-go` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Go distributions, `setup-go` downloads distributions from [`actions/go-versions`](https://github.com/actions/go-versions) on github.com (outside of the appliance). These calls to `actions/go-versions` are made via unauthenticated requests, which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If more requests are made within the time frame, then you will start to see rate-limit errors during downloading that looks like: `##[error]API rate limit exceeded for...`. After that error the action will try to download versions directly from https://storage.googleapis.com/golang, but it also can have rate limit so it's better to put token.
+`setup-go` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Go
+distributions, `setup-go` downloads distributions from [`actions/go-versions`](https://github.com/actions/go-versions)
+on github.com (outside of the appliance). These calls to `actions/go-versions` are made via unauthenticated requests,
+which are limited
+to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If
+more requests are made within the time frame, then you will start to see rate-limit errors during downloading that looks
+like: `##[error]API rate limit exceeded for...`. After that error the action will try to download versions directly
+from https://storage.googleapis.com/golang, but it also can have rate limit so it's better to put token.
 
-To get a higher rate limit, you can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token` input for the action:
+To get a higher rate limit, you
+can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token`
+input for the action:
 
 ```yaml
 uses: actions/setup-go@v3
@@ -210,7 +240,10 @@ with:
   go-version: 1.18
 ```
 
-If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the runner's tool cache. See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/[email protected]/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)" for more information.
+If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the
+runner's tool cache.
+See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/[email protected]/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)"
+for more information.
 
 # License
 

diff --git a/action.yml b/action.yml
@@ -14,7 +14,7 @@ inputs:
     default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
   cache:
     description: Used to specify whether caching is needed. Set to true, if you'd like to enable caching.
-    default: false
+    default: true
   cache-dependency-path:
     description: 'Used to specify the path to a dependency file - go.sum'
   architecture:

diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js
@@ -60356,7 +60356,7 @@ function run() {
             if (typeof error === 'string') {
                 message = error;
             }
-            core.setFailed(message);
+            core.warning(message);
         }
     });
 }
@@ -60379,6 +60379,10 @@ const cachePackages = () => __awaiter(void 0, void 0, void 0, function* () {
     if (nonExistingPaths.length) {
         logWarning(`Cache folder path is retrieved but doesn't exist on disk: ${nonExistingPaths.join(', ')}`);
     }
+    if (!primaryKey) {
+        core.info('Primary key was not generated. Please check the log messages above for more errors or information');
+        return;
+    }
     if (primaryKey === state) {
         core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
         return;
@@ -60457,8 +60461,17 @@ const getPackageManagerInfo = (packageManager) => __awaiter(void 0, void 0, void
 });
 exports.getPackageManagerInfo = getPackageManagerInfo;
 const getCacheDirectoryPath = (packageManagerInfo) => __awaiter(void 0, void 0, void 0, function* () {
-    const pathList = yield Promise.all(packageManagerInfo.cacheFolderCommandList.map((command) => __awaiter(void 0, void 0, void 0, function* () { return exports.getCommandOutput(command); })));
-    const cachePaths = pathList.filter(item => item);
+    const pathOutputs = yield Promise.allSettled(packageManagerInfo.cacheFolderCommandList.map((command) => __awaiter(void 0, void 0, void 0, function* () { return exports.getCommandOutput(command); })));
+    const results = pathOutputs.map(item => {
+        if (item.status === 'fulfilled') {
+            return item.value;
+        }
+        else {
+            core.info(`[warning]getting cache directory path failed: ${item.reason}`);
+        }
+        return '';
+    });
+    const cachePaths = results.filter(item => item);
     if (!cachePaths.length) {
         throw new Error(`Could not get cache folder paths.`);
     }

diff --git a/dist/setup/index.js b/dist/setup/index.js
@@ -63130,8 +63130,17 @@ const getPackageManagerInfo = (packageManager) => __awaiter(void 0, void 0, void
 });
 exports.getPackageManagerInfo = getPackageManagerInfo;
 const getCacheDirectoryPath = (packageManagerInfo) => __awaiter(void 0, void 0, void 0, function* () {
-    const pathList = yield Promise.all(packageManagerInfo.cacheFolderCommandList.map((command) => __awaiter(void 0, void 0, void 0, function* () { return exports.getCommandOutput(command); })));
-    const cachePaths = pathList.filter(item => item);
+    const pathOutputs = yield Promise.allSettled(packageManagerInfo.cacheFolderCommandList.map((command) => __awaiter(void 0, void 0, void 0, function* () { return exports.getCommandOutput(command); })));
+    const results = pathOutputs.map(item => {
+        if (item.status === 'fulfilled') {
+            return item.value;
+        }
+        else {
+            core.info(`[warning]getting cache directory path failed: ${item.reason}`);
+        }
+        return '';
+    });
+    const cachePaths = results.filter(item => item);
     if (!cachePaths.length) {
         throw new Error(`Could not get cache folder paths.`);
     }
@@ -63605,7 +63614,12 @@ function run() {
             if (cache && cache_utils_1.isCacheFeatureAvailable()) {
                 const packageManager = 'default';
                 const cacheDependencyPath = core.getInput('cache-dependency-path');
-                yield cache_restore_1.restoreCache(parseGoVersion(goVersion), packageManager, cacheDependencyPath);
+                try {
+                    yield cache_restore_1.restoreCache(parseGoVersion(goVersion), packageManager, cacheDependencyPath);
+                }
+                catch (error) {
+                    core.warning(`Restore cache failed: ${error.message}`);
+                }
             }
             // add problem matchers
             const matchersPath = path_1.default.join(__dirname, '../..', 'matchers.json');