V4 - Add workflow file for publishing releases to immutable action package (#583)

* Add Publish Immutable Action to V4

* file name update

.github/workflows/basic-validation.yml

@@ -14,5 +14,3 @@ jobs:
   call-basic-validation:
     name: Basic validation
     uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
-    with:
-      node-version: '20'

.github/workflows/check-dist.yml

@@ -15,5 +15,3 @@ jobs:
   call-check-dist:
     name: Check dist/
     uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
-    with:
-      node-version: '20'

.github/workflows/publish-immutable-action.yml

@@ -0,0 +1,20 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@v0.0.4

.github/workflows/versions.yml

@@ -20,7 +20,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go Stable
         uses: ./
         with:
@@ -35,7 +35,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go oldStable
         uses: ./
         with:
@@ -55,7 +55,7 @@ jobs:
           - os: macos-latest
             architecture: x32
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go ${{ matrix.version }} ${{ matrix.architecture }}
         uses: ./
         with:
@@ -74,7 +74,7 @@ jobs:
         go: [1.17, 1.18, 1.19]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: setup-go ${{ matrix.go }}
         uses: ./
@@ -93,7 +93,7 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
         go-version: [1.16, 1.17]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go and check latest
         uses: ./
         with:
@@ -107,9 +107,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, windows-latest, macos-13]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go and check latest
         uses: ./
         with:
@@ -125,7 +125,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go and check latest
         uses: ./
         with:
@@ -140,11 +140,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         go: [1.12.16, 1.13.11, 1.14.3]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: setup-go ${{ matrix.go }}
         uses: ./
@@ -161,11 +161,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        go: [1.9, 1.8.6]
+        os: [macos-13, windows-latest, ubuntu-latest]
+        go: [1.11.12, 1.8.6]
+        exclude:
+          - os: macos-13
+            go: 1.8.6
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: setup-go ${{ matrix.go }}
         uses: ./
@@ -184,7 +187,7 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
         go-version: [1.16, 1.17]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup Go and check latest
         uses: ./
         with:

.github/workflows/windows-validation.yml

@@ -19,7 +19,7 @@ jobs:
         cache: [false, true]
         go: [1.20.1]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: 'Setup ${{ matrix.cache }}, cache: ${{ matrix.go }}'
         uses: ./
@@ -61,7 +61,7 @@ jobs:
             echo 'which go should return "/c/hostedtoolcache/windows/go/${{ matrix.go }}/x64/bin/go"'
             exit 1
           fi
-          if [ $(go env GOROOT) != 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64' ];then
+          if [ $(go env GOROOT) != 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64' ];then 
             echo 'go env GOROOT should return "C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64"'
             exit 1
           fi
@@ -88,7 +88,7 @@ jobs:
       matrix:
         cache: [false, true]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: 'Setup default go, cache: ${{ matrix.cache }}'
         uses: ./
@@ -105,32 +105,10 @@ jobs:
           fi
         shell: bash
 
-      - name: 'Drive D: should not have Go installation, cache: ${{ matrix.cache }}'
+      - name: 'Drive D: should not have Go installation, cache: ${{ matrix.cache}}'
         run: |
           if [ -e 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64' ];then
             echo 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64 should not exist for hosted version of go';
             exit 1
           fi
         shell: bash
-
-  hostedtoolcache:
-    name: 'Validate if hostedtoolcache works as expected'
-    runs-on: windows-latest
-    strategy:
-      matrix:
-        cache: [false]
-        go: [1.20.1]
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: 'Setup ${{ matrix.go }}, cache: ${{ matrix.cache }}'
-        uses: ./
-        with:
-          go-version: ${{ matrix.go }}
-          cache: ${{ matrix.cache }}
-
-      - name: 'Setup ${{ matrix.go }}, cache: ${{ matrix.cache }} (from hostedtoolcache)'
-        uses: ./
-        with:
-          go-version: ${{ matrix.go }}
-          cache: ${{ matrix.cache }}

README.md

@@ -42,7 +42,7 @@ Matching by [semver spec](https://github.com/npm/node-semver):
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '^1.13.1' # The Go version to download (if necessary) and use.
@@ -51,7 +51,7 @@ steps:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '>=1.17.0'
@@ -59,17 +59,17 @@ steps:
 ```
 
 > **Note**: Due to the peculiarities of YAML parsing, it is recommended to wrap the version in single quotation marks:
->
+> 
 > ```yaml
 >   go-version: '1.20'
 >  ```
->
+>  
 > The recommendation is based on the YAML parser's behavior, which interprets non-wrapped values as numbers and, in the case of version 1.20, trims it down to 1.2, which may not be very obvious.
 Matching an unstable pre-release:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use.
@@ -78,7 +78,7 @@ steps:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use.
@@ -93,7 +93,7 @@ See [action.yml](action.yml)
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '1.16.1' # The Go version to download (if necessary) and use.
@@ -114,7 +114,7 @@ want the most up-to-date Go version to always be used.
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '1.14'
@@ -135,7 +135,7 @@ set to `true`
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: 'stable'
@@ -144,7 +144,7 @@ steps:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: 'oldstable'
@@ -159,24 +159,20 @@ 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 input supports glob patterns.
+in different subdirectories.
 
-If some problem that prevents success caching happens then the action issues the warning in the log and continues the execution of the pipeline.
+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@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version: '1.17'
       check-latest: true
-      cache-dependency-path: |
-             subdir/go.sum
-             tools/go.sum
-    # cache-dependency-path: "**/*.sum"
-
+      cache-dependency-path: subdir/go.sum
   - run: go run hello.go
   ```
 
@@ -193,7 +189,7 @@ If both the `go-version` and the `go-version-file` inputs are provided then the
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
   - uses: actions/setup-go@v4
     with:
       go-version-file: 'path/to/go.mod'
@@ -211,7 +207,7 @@ jobs:
         go: [ '1.14', '1.13' ]
     name: Go ${{ matrix.go }} sample
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Setup go
         uses: actions/setup-go@v4
         with:

action.yml

@@ -25,7 +25,7 @@ outputs:
   cache-hit:
     description: 'A boolean value to indicate if a cache was hit'
 runs:
-  using: 'node20'
+  using: 'node16'
   main: 'dist/setup/index.js'
   post: 'dist/cache-save/index.js'
   post-if: success()

docs/adrs/0000-caching-dependencies.md

@@ -4,7 +4,7 @@ Date: 2022-04-13
 Status: Accepted
 
 # Context
-`actions/setup-go` is the one of the most popular action related to Golang in GitHub Actions. Many customers use it in conjunction with [actions/cache](https://github.com/actions/cache) to speed up dependency installation process.
+`actions/setup-go` is the one of the most popular action related to Golang in GitHub Actions. Many customers use it in conjunction with [actions/cache](https://github.com/actions/cache) to speed up dependency installation process.  
 See more examples on proper usage in [actions/cache documentation](https://github.com/actions/cache/blob/main/examples.md#go---modules).
 
 # Goals & Anti-Goals
@@ -16,7 +16,7 @@ Integration of caching functionality into `actions/setup-go` action will bring t
 We don't pursue the goal to provide wide customization of caching in scope of `actions/setup-go` action. The purpose of this integration is covering ~90% of basic use-cases. If user needs flexible customization, we should advice them to use `actions/cache` directly.
 
 # Decision
-- Add `cache` input parameter to `actions/setup-go`. For now, input will accept the following values:
+- Add `cache` input parameter to `actions/setup-go`. For now, input will accept the following values: 
   - `true` - enable caching for go dependencies
   - `false`- disable caching for go dependencies. This value will be set as default value
 - Cache feature will be disabled by default to make sure that we don't break existing customers. We will consider enabling cache by default in next major releases
@@ -32,7 +32,7 @@ We don't pursue the goal to provide wide customization of caching in scope of `a
 
 ```yml
 steps:
-- uses: actions/checkout@v4
+- uses: actions/checkout@v3
 - uses: actions/setup-go@v3
   with:
     go-version: '18'
@@ -43,7 +43,7 @@ steps:
 
  ```yml
 steps:
-- uses: actions/checkout@v4
+- uses: actions/checkout@v3
 - uses: actions/setup-go@v3
   with:
     go-version: '18'
@@ -53,7 +53,7 @@ steps:
 
  ```yml
 steps:
-- uses: actions/checkout@v4
+- uses: actions/checkout@v3
 - uses: actions/setup-go@v3
   with:
     go-version: '18'
@@ -66,4 +66,4 @@ steps:
 # Release process
 
 As soon as functionality is implemented, we will release minor update of action. No need to bump major version since there are no breaking changes for existing users.
-After that, we will update [starter-workflows](https://github.com/actions/starter-workflows/blob/main/ci/go.yml)
+After that, we will update [starter-workflows](https://github.com/actions/starter-workflows/blob/main/ci/go.yml)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-go",
-  "version": "5.0.0",
+  "version": "4.0.0",
   "private": true,
   "description": "setup go action",
   "main": "lib/setup-go.js",
@@ -25,31 +25,31 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.1",
+    "@actions/cache": "^4.0.3",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.0",
-    "@actions/glob": "^0.4.0",
+    "@actions/glob": "^0.2.0",
     "@actions/http-client": "^2.0.1",
     "@actions/io": "^1.0.2",
-    "@actions/tool-cache": "^2.0.1",
-    "semver": "^7.5.4"
+    "@actions/tool-cache": "^1.5.5",
+    "semver": "^6.3.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.10",
-    "@types/node": "^20.10.3",
-    "@types/semver": "^7.5.6",
+    "@types/jest": "^27.0.2",
+    "@types/node": "^16.11.25",
+    "@types/semver": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
     "@typescript-eslint/parser": "^5.54.0",
-    "@vercel/ncc": "^0.38.1",
+    "@vercel/ncc": "^0.33.4",
     "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-node": "^11.1.0",
-    "jest": "^29.7.0",
-    "jest-circus": "^29.7.0",
+    "jest": "^27.2.5",
+    "jest-circus": "^27.2.5",
     "nock": "^10.0.6",
     "prettier": "^2.8.4",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.2"
+    "ts-jest": "^27.0.5",
+    "typescript": "^4.3.3"
   }
 }

src/cache-save.ts

@@ -12,19 +12,9 @@ process.on('uncaughtException', e => {
   core.info(`${warningPrefix}${e.message}`);
 });
 
-// Added early exit to resolve issue with slow post action step:
-// - https://github.com/actions/setup-node/issues/878
-// https://github.com/actions/cache/pull/1217
-export async function run(earlyExit?: boolean) {
+export async function run() {
   try {
-    const cacheInput = core.getBooleanInput('cache');
-    if (cacheInput) {
-      await cachePackages();
-
-      if (earlyExit) {
-        process.exit(0);
-      }
-    }
+    await cachePackages();
   } catch (error) {
     let message = 'Unknown error!';
     if (error instanceof Error) {
@@ -38,6 +28,11 @@ export async function run(earlyExit?: boolean) {
 }
 
 const cachePackages = async () => {
+  const cacheInput = core.getBooleanInput('cache');
+  if (!cacheInput) {
+    return;
+  }
+
   const packageManager = 'default';
 
   const state = core.getState(State.CacheMatchedKey);
@@ -90,4 +85,4 @@ function logWarning(message: string): void {
   core.info(`${warningPrefix}${message}`);
 }
 
-run(true);
+run();

src/installer.ts

@@ -114,9 +114,9 @@ export async function getGo(
         `Received HTTP status code ${err.httpStatusCode}.  This usually indicates the rate limit has been exceeded`
       );
     } else {
-      core.info((err as Error).message);
+      core.info(err.message);
     }
-    core.debug((err as Error).stack ?? '');
+    core.debug(err.stack);
     core.info('Falling back to download directly from Go');
   }
 
@@ -160,7 +160,7 @@ async function resolveVersionFromManifest(
     return info?.resolvedVersion;
   } catch (err) {
     core.info('Unable to resolve a version from the manifest...');
-    core.debug((err as Error).message);
+    core.debug(err.message);
   }
 }
 
@@ -203,17 +203,6 @@ async function cacheWindowsDir(
   fs.symlinkSync(actualToolCacheDir, defaultToolCacheDir, 'junction');
   core.info(`Created link ${defaultToolCacheDir} => ${actualToolCacheDir}`);
 
-  const actualToolCacheCompleteFile = `${actualToolCacheDir}.complete`;
-  const defaultToolCacheCompleteFile = `${defaultToolCacheDir}.complete`;
-  fs.symlinkSync(
-    actualToolCacheCompleteFile,
-    defaultToolCacheCompleteFile,
-    'file'
-  );
-  core.info(
-    `Created link ${defaultToolCacheCompleteFile} => ${actualToolCacheCompleteFile}`
-  );
-
   // make outer code to continue using toolcache as if it were installed on c:
   // restore toolcache root to default drive c:
   process.env['RUNNER_TOOL_CACHE'] = defaultToolCacheRoot;

src/main.ts

@@ -74,7 +74,7 @@ export async function run() {
           cacheDependencyPath
         );
       } catch (error) {
-        core.warning(`Restore cache failed: ${(error as Error).message}`);
+        core.warning(`Restore cache failed: ${error.message}`);
       }
     }
 
@@ -92,7 +92,7 @@ export async function run() {
     core.info(goEnv);
     core.endGroup();
   } catch (error) {
-    core.setFailed((error as Error).message);
+    core.setFailed(error.message);
   }
 }