Merge pull request #769 from actions/users/ashwinsangem/bump_major_version

Bumped up to a major version(v3.0.0)

.eslintrc.json

@@ -9,15 +9,14 @@
     "plugin:import/errors",
     "plugin:import/warnings",
     "plugin:import/typescript",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
+    "plugin:prettier/recommended"
   ],
   "plugins": ["@typescript-eslint", "simple-import-sort", "jest"],
   "rules": {
     "import/first": "error",
     "import/newline-after-import": "error",
     "import/no-duplicates": "error",
-    "simple-import-sort/sort": "error",
+    "simple-import-sort/imports": "error",
     "sort-imports": "off"
   }
 }

.gitattributes

@@ -1 +1,2 @@
-.licenses/** -diff linguist-generated=true
+.licenses/** -diff linguist-generated=true
+* text=auto eol=lf

.github/CODEOWNERS

@@ -1 +1 @@
-* @actions/artifacts-actions
+* @actions/actions-cache

.github/workflows/close-inactive-issues.yml

@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 8 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v3
+        with:
+          days-before-issue-stale: 365
+          days-before-issue-close: 5
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 365 days with no activity. Leave a comment to avoid closing this issue in 5 days."
+          close-issue-message: "This issue was closed because it has been inactive for 5 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.licenses/npm/@actions/cache.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@actions/cache"
-version: 1.0.8
+version: 1.0.10
 type: npm
-summary: Actions cache lib
-homepage: https://github.com/actions/toolkit/tree/main/packages/cache
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE.md

.licenses/npm/@actions/exec.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@actions/exec"
-version: 1.1.0
+version: 1.1.1
 type: npm
-summary: Actions exec lib
-homepage: https://github.com/actions/toolkit/tree/main/packages/exec
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE.md

.licenses/npm/@actions/io.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@actions/io"
-version: 1.1.1
+version: 1.1.2
 type: npm
-summary: Actions io lib
-homepage: https://github.com/actions/toolkit/tree/main/packages/io
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE.md

.licenses/npm/@azure/core-asynciterator-polyfill.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@azure/core-asynciterator-polyfill"
-version: 1.0.0
+version: 1.0.2
 type: npm
-summary: Polyfill for IE/Node 8 for Symbol.asyncIterator
-homepage: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-asynciterator-polyfill
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/@azure/core-http.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@azure/core-http"
-version: 2.2.2
+version: 2.2.4
 type: npm
 summary: Isomorphic client Runtime for Typescript/node.js/browser javascript client
   libraries generated using AutoRest

.licenses/npm/@azure/core-lro.dep.yml

@@ -1,10 +1,9 @@
 ---
 name: "@azure/core-lro"
-version: 2.2.1
+version: 2.2.4
 type: npm
-summary: Isomorphic client library for supporting long-running operations in node.js
-  and browser.
-homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-lro/README.md
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/@azure/core-paging.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@azure/core-paging"
-version: 1.2.0
+version: 1.2.1
 type: npm
 summary: Core types for paging async iterable iterators
 homepage: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-paging/README.md

.licenses/npm/@azure/ms-rest-js.dep.yml

@@ -1,10 +1,9 @@
 ---
 name: "@azure/ms-rest-js"
-version: 2.6.0
+version: 2.6.1
 type: npm
-summary: Isomorphic client Runtime for Typescript/node.js/browser javascript client
-  libraries generated using AutoRest
-homepage: https://github.com/Azure/ms-rest-js
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/@azure/storage-blob.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@azure/storage-blob"
-version: 12.8.0
+version: 12.9.0
 type: npm
-summary: Microsoft Azure Storage SDK for JavaScript - Blob
-homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/@opentelemetry/api.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@opentelemetry/api"
-version: 1.0.3
+version: 1.1.0
 type: npm
-summary: Public API for OpenTelemetry
-homepage: https://github.com/open-telemetry/opentelemetry-js-api#readme
+summary: 
+homepage: 
 license: apache-2.0
 licenses:
 - sources: LICENSE
@@ -218,10 +218,6 @@ licenses:
     [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
     [license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE
     [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
-    [dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg
-    [dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api
-    [devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev
-    [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev
     [npm-url]: https://www.npmjs.com/package/@opentelemetry/api
     [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg
     [docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md

.licenses/npm/@types/node-fetch.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@types/node-fetch"
-version: 2.5.12
+version: 2.6.1
 type: npm
-summary: TypeScript definitions for node-fetch
-homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-fetch
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/@types/node.dep.yml

@@ -1,9 +1,9 @@
 ---
 name: "@types/node"
-version: 12.20.37
+version: 16.11.26
 type: npm
-summary: TypeScript definitions for Node.js
-homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node
+summary: 
+homepage: 
 license: mit
 licenses:
 - sources: LICENSE

.licenses/npm/node-fetch.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: node-fetch
-version: 2.6.6
+version: 2.6.7
 type: npm
 summary: A light-weight module that brings window.fetch to node.js
 homepage: https://github.com/bitinn/node-fetch

README.md

@@ -2,7 +2,7 @@
 
 This action allows caching dependencies and build outputs to improve workflow execution time.
 
-<a href="https://github.com/actions/cache/actions?query=workflow%3ATests"><img alt="GitHub Actions status" src="https://github.com/actions/cache/workflows/Tests/badge.svg?branch=main&event=push"></a>
+[![Tests](https://github.com/actions/cache/actions/workflows/workflow.yml/badge.svg)](https://github.com/actions/cache/actions/workflows/workflow.yml)
 
 ## Documentation
 
@@ -10,7 +10,7 @@ See ["Caching dependencies to speed up workflows"](https://help.github.com/githu
 
 ## What's New
 
-* Added support for multiple paths, [glob patterns](https://github.com/actions/toolkit/tree/main/packages/glob), and single file caches. 
+* Added support for multiple paths, [glob patterns](https://github.com/actions/toolkit/tree/main/packages/glob), and single file caches.
 
 ```yaml
 - name: Cache multiple paths
@@ -34,9 +34,11 @@ Refer [here](https://github.com/actions/cache/blob/v1/README.md) for previous ve
 ### Pre-requisites
 Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
 
+If you are using this inside a container, a POSIX-compliant `tar` needs to be included and accessible in the execution path.
+
 ### Inputs
 
-* `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns. 
+* `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
 * `key` - An explicit key for restoring and saving the cache
 * `restore-keys` - An ordered list of keys to use for restoring the cache if no cache hit occurred for key
 
@@ -47,7 +49,7 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory
 > See [Skipping steps based on cache-hit](#Skipping-steps-based-on-cache-hit) for info on using this output
 
 ### Cache scopes
-The cache is scoped to the key and branch. The default branch cache is available to other branches. 
+The cache is scoped to the key and branch. The default branch cache is available to other branches.
 
 See [Matching a cache key](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key) for more info.
 
@@ -86,11 +88,13 @@ Every programming language and framework has its own way of caching.
 
 See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
 
-- [C# - Nuget](./examples.md#c---nuget)
+- [C# - NuGet](./examples.md#c---nuget)
 - [D - DUB](./examples.md#d---dub)
+- [Deno](./examples.md#deno)
 - [Elixir - Mix](./examples.md#elixir---mix)
 - [Go - Modules](./examples.md#go---modules)
 - [Haskell - Cabal](./examples.md#haskell---cabal)
+- [Haskell - Stack](./examples.md#haskell---stack)
 - [Java - Gradle](./examples.md#java---gradle)
 - [Java - Maven](./examples.md#java---maven)
 - [Node - npm](./examples.md#node---npm)
@@ -117,9 +121,9 @@ For example, using the [`hashFiles`](https://help.github.com/en/actions/referenc
 ```yaml
   - uses: actions/cache@v2
     with:
-      path: | 
+      path: |
         path/to/dependencies
-        some/other/dependencies 
+        some/other/dependencies
       key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
 ```
 
@@ -143,7 +147,7 @@ See [Using contexts to create cache keys](https://help.github.com/en/actions/con
 
 ## Cache Limits
 
-A repository can have up to 5GB of caches. Once the 5GB limit is reached, older caches will be evicted based on when the cache was last accessed.  Caches that are not accessed within the last week will also be evicted.
+A repository can have up to 10GB of caches. Once the 10GB limit is reached, older caches will be evicted based on when the cache was last accessed.  Caches that are not accessed within the last week will also be evicted.
 
 ## Skipping steps based on cache-hit
 
@@ -167,6 +171,12 @@ steps:
 
 > Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
 
+## Known limitation
+
+- `action/cache` is currently not supported on GitHub Enterprise Server. <https://github.com/github/roadmap/issues/273> is tracking this.
+
+Since GitHub Enterprise Server uses self-hosted runners, dependencies are typically cached on the runner by whatever dependency management tool is being used (npm, maven, etc.).  This eliminates the need for explicit caching in some scenarios.
+
 ## Contributing
 We would love for you to contribute to `actions/cache`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 

__tests__/actionUtils.test.ts

@@ -26,7 +26,7 @@ test("isGhes returns true if server url is not github.com", () => {
     }
 });
 
-test("isGhes returns true when server url is github.com", () => {
+test("isGhes returns false when server url is github.com", () => {
     try {
         process.env["GITHUB_SERVER_URL"] = "http://github.com";
         expect(actionUtils.isGhes()).toBe(false);

action.yml

@@ -18,7 +18,7 @@ outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'dist/restore/index.js'
   post: 'dist/save/index.js'
   post-if: 'success()'

examples.md

@@ -4,17 +4,22 @@
 - [D - DUB](#d---dub)
   - [POSIX](#posix)
   - [Windows](#windows)
-- [Elixir - Mix](#elixir---mix)
-- [Go - Modules](#go---modules)
+- [Deno](#deno)
   - [Linux](#linux)
   - [macOS](#macos)
   - [Windows](#windows-1)
+- [Elixir - Mix](#elixir---mix)
+- [Go - Modules](#go---modules)
+  - [Linux](#linux-1)
+  - [macOS](#macos-1)
+  - [Windows](#windows-2)
 - [Haskell - Cabal](#haskell---cabal)
+- [Haskell - Stack](#haskell---stack)
 - [Java - Gradle](#java---gradle)
 - [Java - Maven](#java---maven)
 - [Node - npm](#node---npm)
   - [macOS and Ubuntu](#macos-and-ubuntu)
-  - [Windows](#windows-2)
+  - [Windows](#windows-3)
   - [Using multiple systems and `npm config`](#using-multiple-systems-and-npm-config)
 - [Node - Lerna](#node---lerna)
 - [Node - Yarn](#node---yarn)
@@ -28,8 +33,6 @@
   - [Using pip to get cache location](#using-pip-to-get-cache-location)
 - [Python - pipenv](#python---pipenv)
 - [R - renv](#r---renv)
-  - [Simple example](#simple-example-1)
-  - [Multiple OS's in a workflow](#multiple-oss-in-a-workflow-1)
 - [Ruby - Bundler](#ruby---bundler)
 - [Rust - Cargo](#rust---cargo)
 - [Scala - SBT](#scala---sbt)
@@ -66,6 +69,7 @@ With `actions/cache@v2` you can now exclude unwanted packages with [exclude patt
 
 Or you could move the cache folder like below.
 >Note: This workflow does not work for projects that require files to be placed in user profile package folder
+
 ```yaml
 env:
   NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
@@ -102,6 +106,42 @@ steps:
       ${{ runner.os }}-dub-
 ```
 
+## Deno
+
+### Linux
+
+```yaml
+- uses: actions/cache@v2
+  with:
+    path: |
+      ~/.deno
+      ~/.cache/deno
+    key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
+```
+
+### macOS
+
+```yaml
+- uses: actions/cache@v2
+  with:
+    path: |
+      ~/.deno
+      ~/Library/Caches/deno
+    key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
+```
+
+### Windows
+
+```yaml
+- uses: actions/cache@v2
+  with:
+    path: |
+      ~\.deno
+      %LocalAppData%\deno
+    key: ${{ runner.os }}-deno-${{ hashFiles('**/deps.ts') }}
+```
+
+
 ## Elixir - Mix
 
 ```yaml
@@ -149,8 +189,8 @@ steps:
 - uses: actions/cache@v2
   with:
     path: |
-      %LocalAppData%\go-build
-      ~/go/pkg/mod
+      ~\AppData\Local\go-build
+      ~\go\pkg\mod
     key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
     restore-keys: |
       ${{ runner.os }}-go-
@@ -168,7 +208,27 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
       ~/.cabal/packages
       ~/.cabal/store
       dist-newstyle
-    key: ${{ runner.os }}-${{ matrix.ghc }}
+    key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('**/*.cabal', '**/cabal.project', '**/cabal.project.freeze') }}
+    restore-keys: ${{ runner.os }}-${{ matrix.ghc }}-
+```
+
+## Haskell - Stack
+
+```yaml
+- uses: actions/cache@v2
+  name: Cache ~/.stack
+  with:
+    path: ~/.stack
+    key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
+    restore-keys: |
+      ${{ runner.os }}-stack-global-
+- uses: actions/cache@v2
+  name: Cache .stack-work
+  with:
+    path: .stack-work
+    key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}-${{ hashFiles('**/*.hs') }}
+    restore-keys: |
+      ${{ runner.os }}-stack-work-
 ```
 
 ## Java - Gradle
@@ -254,9 +314,7 @@ If using `npm config` to retrieve the cache directory, ensure you run [actions/s
 - name: restore lerna
   uses: actions/cache@v2
   with:
-    path: |
-      node_modules
-      */*/node_modules
+    path: **/node_modules
     key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
 ```
 

jest.config.js

@@ -17,7 +17,7 @@ const processStdoutWrite = process.stdout.write.bind(process.stdout);
 process.stdout.write = (str, encoding, cb) => {
     // Core library will directly call process.stdout.write for commands
     // We don't want :: commands to be executed by the runner during tests
-    if (!str.match(/^::/)) {
+    if (!String(str).match(/^::/)) {
         return processStdoutWrite(str, encoding, cb);
     }
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "2.1.7",
+  "version": "3.0.0",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
@@ -23,29 +23,29 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^1.0.8",
+    "@actions/cache": "^1.0.10",
     "@actions/core": "^1.2.6",
-    "@actions/exec": "^1.0.1",
-    "@actions/io": "^1.1.0"
+    "@actions/exec": "^1.1.1",
+    "@actions/io": "^1.1.2"
   },
   "devDependencies": {
-    "@types/jest": "^24.0.13",
+    "@types/jest": "^27.4.1",
     "@types/nock": "^11.1.0",
-    "@types/node": "^12.20.7",
-    "@typescript-eslint/eslint-plugin": "^2.7.0",
-    "@typescript-eslint/parser": "^2.7.0",
+    "@types/node": "^16.11.26",
+    "@typescript-eslint/eslint-plugin": "^5.15.0",
+    "@typescript-eslint/parser": "^5.15.0",
     "@zeit/ncc": "^0.20.5",
-    "eslint": "^6.6.0",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^23.20.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-simple-import-sort": "^5.0.2",
-    "jest": "^24.8.0",
-    "jest-circus": "^24.7.1",
+    "eslint": "^8.11.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.1.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "jest": "^27.5.1",
+    "jest-circus": "^27.5.1",
     "nock": "^11.7.0",
-    "prettier": "^1.19.1",
-    "ts-jest": "^26.5.4",
+    "prettier": "^2.6.0",
+    "ts-jest": "^27.1.3",
     "typescript": "^3.9.9"
   }
 }