v1.0.1 release binaries

.eslintrc.json

@@ -1,23 +0,0 @@
-{
-  "env": { "node": true, "jest": true },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": { "ecmaVersion": 2020, "sourceType": "module" },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
-  ],
-  "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",
-    "sort-imports": "off"
-  }
-}

.github/workflows/codeql.yml

@@ -1,52 +0,0 @@
-name: "Code scanning - action"
-
-on:
-  push:
-  pull_request:
-  schedule:
-    - cron: '0 19 * * 0'
-
-jobs:
-  CodeQL-Build:
-
-    # CodeQL runs on ubuntu-latest and windows-latest
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-      with:
-        # We must fetch at least the immediate parents so that if this is
-        # a pull request then we can checkout the head.
-        fetch-depth: 2
-
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-      
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      # Override language selection by uncommenting this and choosing your languages
-      # with:
-      #   languages: go, javascript, csharp, python, cpp, java
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

.github/workflows/workflow.yml

@@ -1,154 +1,31 @@
 name: Tests
-
 on:
   pull_request:
-    branches:
-      - main
-      - releases/**
-    paths-ignore:
-      - '**.md'
   push:
     branches:
-      - main
+      - master
-      - releases/**
     paths-ignore:
       - '**.md'
 
 jobs:
-  # Build and unit test
+  test:
-  build:
+    name: Test on ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, ubuntu-16.04, windows-latest, macOS-latest]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
-      fail-fast: false
     runs-on: ${{ matrix.os }}
+    
     steps:
-    - name: Checkout
+    - uses: actions/checkout@v1
-      uses: actions/checkout@v2
+      
-    - name: Setup Node.js
+    - uses: actions/setup-node@v1
-      uses: actions/setup-node@v1
       with:
         node-version: '12.x'
-    - name: Determine npm cache directory
+
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Restore npm cache
-      uses: actions/cache@v2
-      with:
-        path: ${{ steps.npm-cache.outputs.dir }}
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
     - run: npm ci
+
     - name: Prettier Format Check
       run: npm run format-check
-    - name: ESLint Check
+
-      run: npm run lint
     - name: Build & Test
       run: npm run test
-    - name: Ensure dist/ folder is up-to-date
-      if: ${{ runner.os == 'Linux' }}
-      shell: bash
-      run: |
-        npm run build
-        if [ "$(git diff --ignore-space-at-eol | wc -l)" -gt "0" ]; then
-          echo "Detected uncommitted changes after build.  See status below:"
-          git diff
-          exit 1
-        fi
-        
-
-  # End to end save and restore
-  test-save:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, ubuntu-16.04, windows-latest, macOS-latest]
-      fail-fast: false
-    runs-on: ${{ matrix.os }}
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Generate files in working directory
-      shell: bash
-      run: __tests__/create-cache-files.sh ${{ runner.os }} test-cache
-    - name: Generate files outside working directory
-      shell: bash
-      run: __tests__/create-cache-files.sh ${{ runner.os }} ~/test-cache
-    - name: Save cache
-      uses: ./
-      with:
-        key: test-${{ runner.os }}-${{ github.run_id }}
-        path: |
-          test-cache
-          ~/test-cache
-  test-restore:
-    needs: test-save
-    strategy:
-      matrix:
-        os: [ubuntu-latest, ubuntu-16.04, windows-latest, macOS-latest]
-      fail-fast: false
-    runs-on: ${{ matrix.os }}
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Restore cache
-      uses: ./
-      with:
-        key: test-${{ runner.os }}-${{ github.run_id }}
-        path: |
-          test-cache
-          ~/test-cache
-    - name: Verify cache files in working directory
-      shell: bash
-      run: __tests__/verify-cache-files.sh ${{ runner.os }} test-cache
-    - name: Verify cache files outside working directory
-      shell: bash
-      run: __tests__/verify-cache-files.sh ${{ runner.os }} ~/test-cache
-
-  # End to end with proxy
-  test-proxy-save:
-    runs-on: ubuntu-latest
-    container:
-      image: ubuntu:latest
-      options: --dns 127.0.0.1
-    services:
-      squid-proxy:
-        image: datadog/squid:latest
-        ports:
-          - 3128:3128
-    env:
-      https_proxy: http://squid-proxy:3128
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Generate files
-      run: __tests__/create-cache-files.sh proxy test-cache
-    - name: Save cache
-      uses: ./
-      with:
-        key: test-proxy-${{ github.run_id }}
-        path: test-cache
-  test-proxy-restore:
-    needs: test-proxy-save
-    runs-on: ubuntu-latest
-    container:
-      image: ubuntu:latest
-      options: --dns 127.0.0.1
-    services:
-      squid-proxy:
-        image: datadog/squid:latest
-        ports:
-          - 3128:3128
-    env:
-      https_proxy: http://squid-proxy:3128
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Restore cache
-      uses: ./
-      with:
-        key: test-proxy-${{ github.run_id }}
-        path: test-cache
-    - name: Verify cache
-      run: __tests__/verify-cache-files.sh proxy test-cache

.gitignore

@@ -1,5 +1,8 @@
 __tests__/runner/*
 
+# comment out in distribution branches
+dist/
+
 node_modules/
 lib/
 
@@ -91,6 +94,3 @@ typings/
 
 # DynamoDB Local files
 .dynamodb/
-
-# Text editor files
-.vscode/

README.md

@@ -1,35 +1,13 @@
 # cache
 
-This action allows caching dependencies and build outputs to improve workflow execution time.
+This GitHub 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>
+<a href="https://github.com/actions/cache"><img alt="GitHub Actions status" src="https://github.com/actions/cache/workflows/Tests/badge.svg?branch=master&event=push"></a>
 
 ## Documentation
 
 See ["Caching dependencies to speed up workflows"](https://help.github.com/github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows).
 
-## What's New
-
-* 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
-  uses: actions/cache@v2
-  with:
-    path: |
-      ~/cache
-      !~/cache/exclude
-      **/node_modules
-    key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
-```
-
-* Increased performance and improved cache sizes using `zstd` compression for Linux and macOS runners
-* Allowed caching for all events with a ref. See [events that trigger workflow](https://help.github.com/en/actions/reference/events-that-trigger-workflows) for info on which events do not have a `GITHUB_REF`
-* Released the [`@actions/cache`](https://github.com/actions/toolkit/tree/main/packages/cache) npm package to allow other actions to utilize caching
-* Added a best-effort cleanup step to delete the archive after extraction to reduce storage space
-
-Refer [here](https://github.com/actions/cache/blob/v1/README.md) for previous versions
-
 ## Usage
 
 ### Pre-requisites
@@ -37,7 +15,7 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory
 
 ### 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 directory to store and save the cache
 * `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,103 +25,45 @@ 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. 
-
-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.
-
 ### Example workflow
 
 ```yaml
-name: Caching Primes
+name: Example Caching with npm
 
 on: push
 
 jobs:
   build:
     runs-on: ubuntu-latest
-
+    
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v1
 
-    - name: Cache Primes
+    - name: Cache node modules
-      id: cache-primes
+      uses: actions/cache@v1
-      uses: actions/cache@v2
       with:
-        path: prime-numbers
+        path: node_modules
-        key: ${{ runner.os }}-primes
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
 
-    - name: Generate Prime Numbers
+    - name: Install Dependencies
-      if: steps.cache-primes.outputs.cache-hit != 'true'
+      run: npm install
-      run: /generate-primes.sh -d prime-numbers
+    
+    - name: Build
+      run: npm run build
 
-    - name: Use Prime Numbers
+    - name: Test
-      run: /primes.sh -d prime-numbers
+      run: npm run test
 ```
 
-## Implementation Examples
+## Ecosystem Examples
 
-Every programming language and framework has its own way of caching.
+See [Examples](examples.md)
-
-See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
-
-- [C# - Nuget](./examples.md#c---nuget)
-- [D - DUB](./examples.md#d---dub)
-- [Elixir - Mix](./examples.md#elixir---mix)
-- [Go - Modules](./examples.md#go---modules)
-- [Haskell - Cabal](./examples.md#haskell---cabal)
-- [Java - Gradle](./examples.md#java---gradle)
-- [Java - Maven](./examples.md#java---maven)
-- [Node - npm](./examples.md#node---npm)
-- [Node - Lerna](./examples.md#node---lerna)
-- [Node - Yarn](./examples.md#node---yarn)
-- [OCaml/Reason - esy](./examples.md#ocamlreason---esy)
-- [PHP - Composer](./examples.md#php---composer)
-- [Python - pip](./examples.md#python---pip)
-- [R - renv](./examples.md#r---renv)
-- [Ruby - Bundler](./examples.md#ruby---bundler)
-- [Rust - Cargo](./examples.md#rust---cargo)
-- [Scala - SBT](./examples.md#scala---sbt)
-- [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage)
-- [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods)
-- [Swift - Swift Package Manager](./examples.md#swift---swift-package-manager)
-
-## Creating a cache key
-
-A cache key can include any of the contexts, functions, literals, and operators supported by GitHub Actions.
-
-For example, using the [`hashFiles`](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#hashfiles) function allows you to create a new cache when dependencies change.
-
-```yaml
-  - uses: actions/cache@v2
-    with:
-      path: | 
-        path/to/dependencies
-        some/other/dependencies 
-      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
-```
-
-Additionally, you can use arbitrary command output in a cache key, such as a date or software version:
-
-```yaml
-  # http://man7.org/linux/man-pages/man1/date.1.html
-  - name: Get Date
-    id: get-date
-    run: |
-      echo "::set-output name=date::$(/bin/date -u "+%Y%m%d")"
-    shell: bash
-
-  - uses: actions/cache@v2
-    with:
-      path: path/to/dependencies
-      key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
-```
-
-See [Using contexts to create cache keys](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#using-contexts-to-create-cache-keys)
 
 ## 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.
+Individual caches are limited to 400MB and a repository can have up to 2GB of caches. Once the 2GB 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
 
@@ -152,14 +72,14 @@ Using the `cache-hit` output, subsequent steps (such as install or build) can be
 Example:
 ```yaml
 steps:
-  - uses: actions/checkout@v2
+  - uses: actions/checkout@v1
 
-  - uses: actions/cache@v2
+  - uses: actions/cache@v1
     id: cache
     with:
       path: path/to/dependencies
-      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles')}}
-
+  
   - name: Install Dependencies
     if: steps.cache.outputs.cache-hit != 'true'
     run: /install.sh
@@ -168,7 +88,7 @@ steps:
 > Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
 
 ## 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.
+We would love for you to contribute to `@actions/cache`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 
 ## License
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

__tests__/__fixtures__/helloWorld.txt

@@ -1 +0,0 @@
-hello world

__tests__/actionUtils.test.ts

@@ -1,196 +0,0 @@
-import * as core from "@actions/core";
-
-import { Events, Outputs, RefKey, State } from "../src/constants";
-import * as actionUtils from "../src/utils/actionUtils";
-import * as testUtils from "../src/utils/testUtils";
-
-jest.mock("@actions/core");
-
-beforeAll(() => {
-    jest.spyOn(core, "getInput").mockImplementation((name, options) => {
-        return jest.requireActual("@actions/core").getInput(name, options);
-    });
-});
-
-afterEach(() => {
-    delete process.env[Events.Key];
-    delete process.env[RefKey];
-});
-
-test("isExactKeyMatch with undefined cache key returns false", () => {
-    const key = "linux-rust";
-    const cacheKey = undefined;
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false);
-});
-
-test("isExactKeyMatch with empty cache key returns false", () => {
-    const key = "linux-rust";
-    const cacheKey = "";
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false);
-});
-
-test("isExactKeyMatch with different keys returns false", () => {
-    const key = "linux-rust";
-    const cacheKey = "linux-";
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false);
-});
-
-test("isExactKeyMatch with different key accents returns false", () => {
-    const key = "linux-áccent";
-    const cacheKey = "linux-accent";
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false);
-});
-
-test("isExactKeyMatch with same key returns true", () => {
-    const key = "linux-rust";
-    const cacheKey = "linux-rust";
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(true);
-});
-
-test("isExactKeyMatch with same key and different casing returns true", () => {
-    const key = "linux-rust";
-    const cacheKey = "LINUX-RUST";
-
-    expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(true);
-});
-
-test("setOutputAndState with undefined entry to set cache-hit output", () => {
-    const key = "linux-rust";
-    const cacheKey = undefined;
-
-    const setOutputMock = jest.spyOn(core, "setOutput");
-    const saveStateMock = jest.spyOn(core, "saveState");
-
-    actionUtils.setOutputAndState(key, cacheKey);
-
-    expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "false");
-    expect(setOutputMock).toHaveBeenCalledTimes(1);
-
-    expect(saveStateMock).toHaveBeenCalledTimes(0);
-});
-
-test("setOutputAndState with exact match to set cache-hit output and state", () => {
-    const key = "linux-rust";
-    const cacheKey = "linux-rust";
-
-    const setOutputMock = jest.spyOn(core, "setOutput");
-    const saveStateMock = jest.spyOn(core, "saveState");
-
-    actionUtils.setOutputAndState(key, cacheKey);
-
-    expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "true");
-    expect(setOutputMock).toHaveBeenCalledTimes(1);
-
-    expect(saveStateMock).toHaveBeenCalledWith(State.CacheMatchedKey, cacheKey);
-    expect(saveStateMock).toHaveBeenCalledTimes(1);
-});
-
-test("setOutputAndState with no exact match to set cache-hit output and state", () => {
-    const key = "linux-rust";
-    const cacheKey = "linux-rust-bb828da54c148048dd17899ba9fda624811cfb43";
-
-    const setOutputMock = jest.spyOn(core, "setOutput");
-    const saveStateMock = jest.spyOn(core, "saveState");
-
-    actionUtils.setOutputAndState(key, cacheKey);
-
-    expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "false");
-    expect(setOutputMock).toHaveBeenCalledTimes(1);
-
-    expect(saveStateMock).toHaveBeenCalledWith(State.CacheMatchedKey, cacheKey);
-    expect(saveStateMock).toHaveBeenCalledTimes(1);
-});
-
-test("getCacheState with no state returns undefined", () => {
-    const getStateMock = jest.spyOn(core, "getState");
-    getStateMock.mockImplementation(() => {
-        return "";
-    });
-
-    const state = actionUtils.getCacheState();
-
-    expect(state).toBe(undefined);
-
-    expect(getStateMock).toHaveBeenCalledWith(State.CacheMatchedKey);
-    expect(getStateMock).toHaveBeenCalledTimes(1);
-});
-
-test("getCacheState with valid state", () => {
-    const cacheKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-
-    const getStateMock = jest.spyOn(core, "getState");
-    getStateMock.mockImplementation(() => {
-        return cacheKey;
-    });
-
-    const state = actionUtils.getCacheState();
-
-    expect(state).toEqual(cacheKey);
-
-    expect(getStateMock).toHaveBeenCalledWith(State.CacheMatchedKey);
-    expect(getStateMock).toHaveBeenCalledTimes(1);
-});
-
-test("logWarning logs a message with a warning prefix", () => {
-    const message = "A warning occurred.";
-
-    const infoMock = jest.spyOn(core, "info");
-
-    actionUtils.logWarning(message);
-
-    expect(infoMock).toHaveBeenCalledWith(`[warning]${message}`);
-});
-
-test("isValidEvent returns false for event that does not have a branch or tag", () => {
-    const event = "foo";
-    process.env[Events.Key] = event;
-
-    const isValidEvent = actionUtils.isValidEvent();
-
-    expect(isValidEvent).toBe(false);
-});
-
-test("isValidEvent returns true for event that has a ref", () => {
-    const event = Events.Push;
-    process.env[Events.Key] = event;
-    process.env[RefKey] = "ref/heads/feature";
-
-    const isValidEvent = actionUtils.isValidEvent();
-
-    expect(isValidEvent).toBe(true);
-});
-
-test("getInputAsArray returns empty array if not required and missing", () => {
-    expect(actionUtils.getInputAsArray("foo")).toEqual([]);
-});
-
-test("getInputAsArray throws error if required and missing", () => {
-    expect(() =>
-        actionUtils.getInputAsArray("foo", { required: true })
-    ).toThrowError();
-});
-
-test("getInputAsArray handles single line correctly", () => {
-    testUtils.setInput("foo", "bar");
-    expect(actionUtils.getInputAsArray("foo")).toEqual(["bar"]);
-});
-
-test("getInputAsArray handles multiple lines correctly", () => {
-    testUtils.setInput("foo", "bar\nbaz");
-    expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]);
-});
-
-test("getInputAsArray handles different new lines correctly", () => {
-    testUtils.setInput("foo", "bar\r\nbaz");
-    expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]);
-});
-
-test("getInputAsArray handles empty lines correctly", () => {
-    testUtils.setInput("foo", "\n\nbar\n\nbaz\n\n");
-    expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]);
-});

__tests__/create-cache-files.sh

@@ -1,17 +0,0 @@
-#!/bin/sh
-
-# Validate args
-prefix="$1"
-if [ -z "$prefix" ]; then
-  echo "Must supply prefix argument"
-  exit 1
-fi
-
-path="$2"
-if [ -z "$path" ]; then
-  echo "Must supply path argument"
-  exit 1
-fi
-
-mkdir -p $path
-echo "$prefix $GITHUB_RUN_ID" > $path/test-file.txt

__tests__/main.test.ts

@@ -0,0 +1,22 @@
+import * as core from "@actions/core";
+
+import { Inputs } from "../src/constants";
+import run from "../src/restore";
+import * as testUtils from "../src/utils/testUtils";
+
+test("restore with no path", async () => {
+    const failedMock = jest.spyOn(core, "setFailed");
+    await run();
+    expect(failedMock).toHaveBeenCalledWith(
+        "Input required and not supplied: path"
+    );
+});
+
+test("restore with no key", async () => {
+    testUtils.setInput(Inputs.Path, "node_modules");
+    const failedMock = jest.spyOn(core, "setFailed");
+    await run();
+    expect(failedMock).toHaveBeenCalledWith(
+        "Input required and not supplied: key"
+    );
+});

__tests__/restore.test.ts

@@ -1,291 +0,0 @@
-import * as cache from "@actions/cache";
-import * as core from "@actions/core";
-
-import { Events, Inputs, RefKey } from "../src/constants";
-import run from "../src/restore";
-import * as actionUtils from "../src/utils/actionUtils";
-import * as testUtils from "../src/utils/testUtils";
-
-jest.mock("../src/utils/actionUtils");
-
-beforeAll(() => {
-    jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation(
-        (key, cacheResult) => {
-            const actualUtils = jest.requireActual("../src/utils/actionUtils");
-            return actualUtils.isExactKeyMatch(key, cacheResult);
-        }
-    );
-
-    jest.spyOn(actionUtils, "isValidEvent").mockImplementation(() => {
-        const actualUtils = jest.requireActual("../src/utils/actionUtils");
-        return actualUtils.isValidEvent();
-    });
-
-    jest.spyOn(actionUtils, "getInputAsArray").mockImplementation(
-        (name, options) => {
-            const actualUtils = jest.requireActual("../src/utils/actionUtils");
-            return actualUtils.getInputAsArray(name, options);
-        }
-    );
-});
-
-beforeEach(() => {
-    process.env[Events.Key] = Events.Push;
-    process.env[RefKey] = "refs/heads/feature-branch";
-});
-
-afterEach(() => {
-    testUtils.clearInputs();
-    delete process.env[Events.Key];
-    delete process.env[RefKey];
-});
-
-test("restore with invalid event outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const invalidEvent = "commit_comment";
-    process.env[Events.Key] = invalidEvent;
-    delete process.env[RefKey];
-    await run();
-    expect(logWarningMock).toHaveBeenCalledWith(
-        `Event Validation Error: The event type ${invalidEvent} is not supported because it's not tied to a branch or tag ref.`
-    );
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("restore with no path should fail", async () => {
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await run();
-    expect(restoreCacheMock).toHaveBeenCalledTimes(0);
-    // this input isn't necessary for restore b/c tarball contains entries relative to workspace
-    expect(failedMock).not.toHaveBeenCalledWith(
-        "Input required and not supplied: path"
-    );
-});
-
-test("restore with no key", async () => {
-    testUtils.setInput(Inputs.Path, "node_modules");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await run();
-    expect(restoreCacheMock).toHaveBeenCalledTimes(0);
-    expect(failedMock).toHaveBeenCalledWith(
-        "Input required and not supplied: key"
-    );
-});
-
-test("restore with too many keys should fail", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    const restoreKeys = [...Array(20).keys()].map(x => x.toString());
-    testUtils.setInputs({
-        path: path,
-        key,
-        restoreKeys
-    });
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await run();
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, restoreKeys);
-    expect(failedMock).toHaveBeenCalledWith(
-        `Key Validation Error: Keys are limited to a maximum of 10.`
-    );
-});
-
-test("restore with large key should fail", async () => {
-    const path = "node_modules";
-    const key = "foo".repeat(512); // Over the 512 character limit
-    testUtils.setInputs({
-        path: path,
-        key
-    });
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await run();
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
-    expect(failedMock).toHaveBeenCalledWith(
-        `Key Validation Error: ${key} cannot be larger than 512 characters.`
-    );
-});
-
-test("restore with invalid key should fail", async () => {
-    const path = "node_modules";
-    const key = "comma,comma";
-    testUtils.setInputs({
-        path: path,
-        key
-    });
-    const failedMock = jest.spyOn(core, "setFailed");
-    const restoreCacheMock = jest.spyOn(cache, "restoreCache");
-    await run();
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
-    expect(failedMock).toHaveBeenCalledWith(
-        `Key Validation Error: ${key} cannot contain commas.`
-    );
-});
-
-test("restore with no cache found", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    testUtils.setInputs({
-        path: path,
-        key
-    });
-
-    const infoMock = jest.spyOn(core, "info");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const stateMock = jest.spyOn(core, "saveState");
-    const restoreCacheMock = jest
-        .spyOn(cache, "restoreCache")
-        .mockImplementationOnce(() => {
-            return Promise.resolve(undefined);
-        });
-
-    await run();
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
-
-    expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-
-    expect(infoMock).toHaveBeenCalledWith(
-        `Cache not found for input keys: ${key}`
-    );
-});
-
-test("restore with server error should fail", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    testUtils.setInputs({
-        path: path,
-        key
-    });
-
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const stateMock = jest.spyOn(core, "saveState");
-    const restoreCacheMock = jest
-        .spyOn(cache, "restoreCache")
-        .mockImplementationOnce(() => {
-            throw new Error("HTTP Error Occurred");
-        });
-    const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
-
-    await run();
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
-
-    expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-
-    expect(logWarningMock).toHaveBeenCalledTimes(1);
-    expect(logWarningMock).toHaveBeenCalledWith("HTTP Error Occurred");
-
-    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
-    expect(setCacheHitOutputMock).toHaveBeenCalledWith(false);
-
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("restore with restore keys and no cache found", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    const restoreKey = "node-";
-    testUtils.setInputs({
-        path: path,
-        key,
-        restoreKeys: [restoreKey]
-    });
-
-    const infoMock = jest.spyOn(core, "info");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const stateMock = jest.spyOn(core, "saveState");
-    const restoreCacheMock = jest
-        .spyOn(cache, "restoreCache")
-        .mockImplementationOnce(() => {
-            return Promise.resolve(undefined);
-        });
-
-    await run();
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]);
-
-    expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-
-    expect(infoMock).toHaveBeenCalledWith(
-        `Cache not found for input keys: ${key}, ${restoreKey}`
-    );
-});
-
-test("restore with cache found for key", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    testUtils.setInputs({
-        path: path,
-        key
-    });
-
-    const infoMock = jest.spyOn(core, "info");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const stateMock = jest.spyOn(core, "saveState");
-    const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
-    const restoreCacheMock = jest
-        .spyOn(cache, "restoreCache")
-        .mockImplementationOnce(() => {
-            return Promise.resolve(key);
-        });
-
-    await run();
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
-
-    expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
-    expect(setCacheHitOutputMock).toHaveBeenCalledWith(true);
-
-    expect(infoMock).toHaveBeenCalledWith(`Cache restored from key: ${key}`);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("restore with cache found for restore key", async () => {
-    const path = "node_modules";
-    const key = "node-test";
-    const restoreKey = "node-";
-    testUtils.setInputs({
-        path: path,
-        key,
-        restoreKeys: [restoreKey]
-    });
-
-    const infoMock = jest.spyOn(core, "info");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const stateMock = jest.spyOn(core, "saveState");
-    const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
-    const restoreCacheMock = jest
-        .spyOn(cache, "restoreCache")
-        .mockImplementationOnce(() => {
-            return Promise.resolve(restoreKey);
-        });
-
-    await run();
-
-    expect(restoreCacheMock).toHaveBeenCalledTimes(1);
-    expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]);
-
-    expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
-    expect(setCacheHitOutputMock).toHaveBeenCalledWith(false);
-
-    expect(infoMock).toHaveBeenCalledWith(
-        `Cache restored from key: ${restoreKey}`
-    );
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});

__tests__/save.test.ts

@@ -1,301 +0,0 @@
-import * as cache from "@actions/cache";
-import * as core from "@actions/core";
-
-import { Events, Inputs, RefKey } from "../src/constants";
-import run from "../src/save";
-import * as actionUtils from "../src/utils/actionUtils";
-import * as testUtils from "../src/utils/testUtils";
-
-jest.mock("@actions/core");
-jest.mock("@actions/cache");
-jest.mock("../src/utils/actionUtils");
-
-beforeAll(() => {
-    jest.spyOn(core, "getInput").mockImplementation((name, options) => {
-        return jest.requireActual("@actions/core").getInput(name, options);
-    });
-
-    jest.spyOn(actionUtils, "getCacheState").mockImplementation(() => {
-        return jest.requireActual("../src/utils/actionUtils").getCacheState();
-    });
-
-    jest.spyOn(actionUtils, "getInputAsArray").mockImplementation(
-        (name, options) => {
-            return jest
-                .requireActual("../src/utils/actionUtils")
-                .getInputAsArray(name, options);
-        }
-    );
-
-    jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation(
-        (key, cacheResult) => {
-            return jest
-                .requireActual("../src/utils/actionUtils")
-                .isExactKeyMatch(key, cacheResult);
-        }
-    );
-
-    jest.spyOn(actionUtils, "isValidEvent").mockImplementation(() => {
-        const actualUtils = jest.requireActual("../src/utils/actionUtils");
-        return actualUtils.isValidEvent();
-    });
-});
-
-beforeEach(() => {
-    process.env[Events.Key] = Events.Push;
-    process.env[RefKey] = "refs/heads/feature-branch";
-});
-
-afterEach(() => {
-    testUtils.clearInputs();
-    delete process.env[Events.Key];
-    delete process.env[RefKey];
-});
-
-test("save with invalid event outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-    const invalidEvent = "commit_comment";
-    process.env[Events.Key] = invalidEvent;
-    delete process.env[RefKey];
-    await run();
-    expect(logWarningMock).toHaveBeenCalledWith(
-        `Event Validation Error: The event type ${invalidEvent} is not supported because it's not tied to a branch or tag ref.`
-    );
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with no primary key in state outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const savedCacheKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return "";
-        });
-    const saveCacheMock = jest.spyOn(cache, "saveCache");
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(0);
-    expect(logWarningMock).toHaveBeenCalledWith(
-        `Error retrieving key from state.`
-    );
-    expect(logWarningMock).toHaveBeenCalledTimes(1);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with exact match returns early", async () => {
-    const infoMock = jest.spyOn(core, "info");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = primaryKey;
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-    const saveCacheMock = jest.spyOn(cache, "saveCache");
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(0);
-    expect(infoMock).toHaveBeenCalledWith(
-        `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
-    );
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with missing input outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = "Linux-node-";
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-    const saveCacheMock = jest.spyOn(cache, "saveCache");
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(0);
-    expect(logWarningMock).toHaveBeenCalledWith(
-        "Input required and not supplied: path"
-    );
-    expect(logWarningMock).toHaveBeenCalledTimes(1);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with large cache outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = "Linux-node-";
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-
-    const inputPath = "node_modules";
-    testUtils.setInput(Inputs.Path, inputPath);
-
-    const saveCacheMock = jest
-        .spyOn(cache, "saveCache")
-        .mockImplementationOnce(() => {
-            throw new Error(
-                "Cache size of ~6144 MB (6442450944 B) is over the 5GB limit, not saving cache."
-            );
-        });
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(1);
-    expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey);
-
-    expect(logWarningMock).toHaveBeenCalledTimes(1);
-    expect(logWarningMock).toHaveBeenCalledWith(
-        "Cache size of ~6144 MB (6442450944 B) is over the 5GB limit, not saving cache."
-    );
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with reserve cache failure outputs warning", async () => {
-    const infoMock = jest.spyOn(core, "info");
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = "Linux-node-";
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-
-    const inputPath = "node_modules";
-    testUtils.setInput(Inputs.Path, inputPath);
-
-    const saveCacheMock = jest
-        .spyOn(cache, "saveCache")
-        .mockImplementationOnce(() => {
-            const actualCache = jest.requireActual("@actions/cache");
-            const error = new actualCache.ReserveCacheError(
-                `Unable to reserve cache with key ${primaryKey}, another job may be creating this cache.`
-            );
-            throw error;
-        });
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(1);
-    expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey);
-
-    expect(infoMock).toHaveBeenCalledWith(
-        `Unable to reserve cache with key ${primaryKey}, another job may be creating this cache.`
-    );
-    expect(logWarningMock).toHaveBeenCalledTimes(0);
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with server error outputs warning", async () => {
-    const logWarningMock = jest.spyOn(actionUtils, "logWarning");
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = "Linux-node-";
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-
-    const inputPath = "node_modules";
-    testUtils.setInput(Inputs.Path, inputPath);
-
-    const saveCacheMock = jest
-        .spyOn(cache, "saveCache")
-        .mockImplementationOnce(() => {
-            throw new Error("HTTP Error Occurred");
-        });
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(1);
-    expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey);
-
-    expect(logWarningMock).toHaveBeenCalledTimes(1);
-    expect(logWarningMock).toHaveBeenCalledWith("HTTP Error Occurred");
-
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});
-
-test("save with valid inputs uploads a cache", async () => {
-    const failedMock = jest.spyOn(core, "setFailed");
-
-    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
-    const savedCacheKey = "Linux-node-";
-
-    jest.spyOn(core, "getState")
-        // Cache Entry State
-        .mockImplementationOnce(() => {
-            return savedCacheKey;
-        })
-        // Cache Key State
-        .mockImplementationOnce(() => {
-            return primaryKey;
-        });
-
-    const inputPath = "node_modules";
-    testUtils.setInput(Inputs.Path, inputPath);
-
-    const cacheId = 4;
-    const saveCacheMock = jest
-        .spyOn(cache, "saveCache")
-        .mockImplementationOnce(() => {
-            return Promise.resolve(cacheId);
-        });
-
-    await run();
-
-    expect(saveCacheMock).toHaveBeenCalledTimes(1);
-    expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey);
-
-    expect(failedMock).toHaveBeenCalledTimes(0);
-});

__tests__/verify-cache-files.sh

@@ -1,36 +0,0 @@
-#!/bin/sh
-
-# Validate args
-prefix="$1"
-if [ -z "$prefix" ]; then
-  echo "Must supply prefix argument"
-  exit 1
-fi
-
-path="$2"
-if [ -z "$path" ]; then
-  echo "Must specify path argument"
-  exit 1
-fi
-
-# Sanity check GITHUB_RUN_ID defined
-if [ -z "$GITHUB_RUN_ID" ]; then
-  echo "GITHUB_RUN_ID not defined"
-  exit 1
-fi
-
-# Verify file exists
-file="$path/test-file.txt"
-echo "Checking for $file"
-if [ ! -e $file ]; then
-  echo "File does not exist"
-  exit 1
-fi
-
-# Verify file content
-content="$(cat $file)"
-echo "File content:\n$content"
-if [ -z "$(echo $content | grep --fixed-strings "$prefix $GITHUB_RUN_ID")" ]; then
-  echo "Unexpected file content"
-  exit 1
-fi

action.yml

@@ -1,9 +1,9 @@
 name: 'Cache'
-description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time'
+description: 'Cache dependencies and build outputs to improve workflow execution time'
 author: 'GitHub'
 inputs:
   path:
-    description: 'A list of files, directories, and wildcard patterns to cache and restore'
+    description: 'A directory to store and save the cache'
     required: true
   key:
     description: 'An explicit key for restoring and saving the cache'
@@ -21,4 +21,4 @@ runs:
   post-if: 'success()'
 branding:
   icon: 'archive'
-  color: 'gray-dark'
+  color: 'gray-dark'

examples.md

@@ -1,42 +1,22 @@
 # Examples
 
-- [Examples](#examples)
+- [C# - Nuget](#c---nuget)
-  - [C# - NuGet](#c---nuget)
+- [Elixir - Mix](#elixir---mix)
-  - [D - DUB](#d---dub)
+- [Go - Modules](#go---modules)
-  - [Elixir - Mix](#elixir---mix)
+- [Java - Gradle](#java---gradle)
-  - [Go - Modules](#go---modules)
+- [Java - Maven](#java---maven)
-  - [Haskell - Cabal](#haskell---cabal)
+- [Node - npm](#node---npm)
-  - [Java - Gradle](#java---gradle)
+- [Node - Yarn](#node---yarn)
-  - [Java - Maven](#java---maven)
+- [Ruby - Gem](#ruby---gem)
-  - [Node - npm](#node---npm)
+- [Rust - Cargo](#rust---cargo)
-    - [macOS and Ubuntu](#macos-and-ubuntu)
+- [Swift, Objective-C - Carthage](#swift-objective-c---carthage)
-    - [Windows](#windows)
+- [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods)
-    - [Using multiple systems and `npm config`](#using-multiple-systems-and-npm-config)
-  - [Node - Lerna](#node---lerna)
-  - [Node - Yarn](#node---yarn)
-  - [Node - Yarn 2](#node---yarn-2)
-  - [OCaml/Reason - esy](#ocamlreason---esy)
-  - [PHP - Composer](#php---composer)
-  - [Python - pip](#python---pip)
-    - [Simple example](#simple-example)
-    - [Multiple OS's in a workflow](#multiple-oss-in-a-workflow)
-    - [Using pip to get cache location](#using-pip-to-get-cache-location)
-    - [Using a script to get cache location](#using-a-script-to-get-cache-location)
-  - [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)
-  - [Swift, Objective-C - Carthage](#swift-objective-c---carthage)
-  - [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods)
-  - [Swift - Swift Package Manager](#swift---swift-package-manager)
 
-## C# - NuGet
+## C# - Nuget
 Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies):
 
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
     path: ~/.nuget/packages
     key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
@@ -44,60 +24,9 @@ Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/packa
       ${{ runner.os }}-nuget-
 ```
 
-Depending on the environment, huge packages might be pre-installed in the global cache folder.
-With `actions/cache@v2` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: | 
-      ~/.nuget/packages
-      !~/.nuget/packages/unwanted
-    key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
-    restore-keys: |
-      ${{ runner.os }}-nuget-
-```
-
-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
-steps:
-  - uses: actions/cache@v2
-    with:
-      path: ${{ github.workspace }}/.nuget/packages
-      key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
-      restore-keys: |
-        ${{ runner.os }}-nuget-
-```
-
-## D - DUB
-
-### POSIX
-
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: ~/.dub
-    key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.json') }}
-    restore-keys: |
-      ${{ runner.os }}-dub-
-```
-
-### Windows
-
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: ~\AppData\Local\dub
-    key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.json') }}
-    restore-keys: |
-      ${{ runner.os }}-dub-
-```
-
 ## Elixir - Mix
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
     path: deps
     key: ${{ runner.os }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
@@ -108,7 +37,7 @@ steps:
 ## Go - Modules
 
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
     path: ~/go/pkg/mod
     key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
@@ -116,30 +45,13 @@ steps:
       ${{ runner.os }}-go-
 ```
 
-## Haskell - Cabal
-
-We cache the elements of the Cabal store separately, as the entirety of `~/.cabal` can grow very large for projects with many dependencies.
-
-```yaml
-- name: Cache ~/.cabal/packages, ~/.cabal/store and dist-newstyle
-  uses: actions/cache@v2
-  with:
-    path: |
-      ~/.cabal/packages
-      ~/.cabal/store
-      dist-newstyle
-    key: ${{ runner.os }}-${{ matrix.ghc }}
-```
-
 ## Java - Gradle
 
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
-    path: |
+    path: ~/.gradle/caches
-      ~/.gradle/caches
+    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
-      ~/.gradle/wrapper
-    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
     restore-keys: |
       ${{ runner.os }}-gradle-
 ```
@@ -147,8 +59,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 ## Java - Maven
 
 ```yaml
-- name: Cache local Maven repository
+- uses: actions/cache@v1
-  uses: actions/cache@v2
   with:
     path: ~/.m2/repository
     key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -158,323 +69,61 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 
 ## Node - npm
 
-For npm, cache files are stored in `~/.npm` on Posix, or `%AppData%/npm-cache` on Windows. See https://docs.npmjs.com/cli/cache#cache
-
-If using `npm config` to retrieve the cache directory, ensure you run [actions/setup-node](https://github.com/actions/setup-node) first to ensure your `npm` version is correct.
-
->Note: It is not recommended to cache `node_modules`, as it can break across Node versions and won't work with `npm ci`
-
-### macOS and Ubuntu
-
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
-    path: ~/.npm
+    path: node_modules
     key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
     restore-keys: |
       ${{ runner.os }}-node-
 ```
 
-### Windows
-
-```yaml
-- name: Get npm cache directory
-  id: npm-cache
-  run: |
-    echo "::set-output name=dir::$(npm config get cache)"
-- uses: actions/cache@v2
-  with:
-    path: ${{ steps.npm-cache.outputs.dir }}
-    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-    restore-keys: |
-      ${{ runner.os }}-node-
-```
-
-### Using multiple systems and `npm config`
-
-```yaml
-- name: Get npm cache directory
-  id: npm-cache
-  run: |
-    echo "::set-output name=dir::$(npm config get cache)"
-- uses: actions/cache@v2
-  with:
-    path: ${{ steps.npm-cache.outputs.dir }}
-    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-    restore-keys: |
-      ${{ runner.os }}-node-
-```
-
-## Node - Lerna
-
-```yaml
-- name: restore lerna
-  uses: actions/cache@v2
-  with:
-    path: |
-      node_modules
-      */*/node_modules
-    key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
-```
-
 ## Node - Yarn
-The yarn cache directory will depend on your operating system and version of `yarn`. See https://yarnpkg.com/lang/en/docs/cli/cache/ for more info.
 
 ```yaml
-- name: Get yarn cache directory path
+- uses: actions/cache@v1
-  id: yarn-cache-dir-path
-  run: echo "::set-output name=dir::$(yarn cache dir)"
-
-- uses: actions/cache@v2
-  id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
   with:
-    path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+    path: ~/.cache/yarn
-    key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+    key: ${{ runner.os }}-yarn-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
     restore-keys: |
       ${{ runner.os }}-yarn-
 ```
 
-
+## Ruby - Gem
-## Node - Yarn 2
-The yarn 2 cache directory will depend on your config. See https://yarnpkg.com/configuration/yarnrc#cacheFolder for more info.
 
 ```yaml
-- name: Get yarn cache directory path
+- uses: actions/cache@v1
-  id: yarn-cache-dir-path
-  run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
-
-- uses: actions/cache@v2
-  id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-  with:
-    path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-    key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-yarn-
-```
-
-## OCaml/Reason - esy
-Esy allows you to export built dependencies and import pre-built dependencies.
-```yaml
-    - name: Restore Cache
-      id: restore-cache
-      uses: actions/cache@v2
-      with:
-        path: _export
-        key:  ${{ runner.os }}-esy-${{ hashFiles('esy.lock/index.json') }}
-        restore-keys: |
-          ${{ runner.os }}-esy-
-    - name: Esy install
-      run: 'esy install'
-    - name: Import Cache
-      run: |
-        esy import-dependencies _export
-        rm -rf _export
-
-    ...(Build job)...
-
-    # Re-export dependencies if anything has changed or if it is the first time
-    - name: Setting dependency cache 
-      run: |
-        esy export-dependencies
-      if: steps.restore-cache.outputs.cache-hit != 'true'
-```
-
-
-## PHP - Composer
-
-```yaml
-- name: Get Composer Cache Directory
-  id: composer-cache
-  run: |
-    echo "::set-output name=dir::$(composer config cache-files-dir)"
-- uses: actions/cache@v2
-  with:
-    path: ${{ steps.composer-cache.outputs.dir }}
-    key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-composer-
-```
-
-## Python - pip
-
-For pip, the cache directory will vary by OS. See https://pip.pypa.io/en/stable/reference/pip_install/#caching
-
-Locations:
- - Ubuntu: `~/.cache/pip`
- - Windows: `~\AppData\Local\pip\Cache`
- - macOS: `~/Library/Caches/pip`
-
-### Simple example
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: ~/.cache/pip
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-```
-
-Replace `~/.cache/pip` with the correct `path` if not using Ubuntu.
-
-### Multiple OS's in a workflow
-
-```yaml
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'Linux')
-  with:
-    path: ~/.cache/pip
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'macOS')
-  with:
-    path: ~/Library/Caches/pip
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'Windows')
-  with:
-    path: ~\AppData\Local\pip\Cache
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-```
-
-### Using pip to get cache location
-
-> Note: This requires pip 20.1+
-```yaml
-- name: Get pip cache dir
-  id: pip-cache
-  run: |
-    echo "::set-output name=dir::$(pip cache dir)"
-
-- name: pip cache
-  uses: actions/cache@v2
-  with:
-    path: ${{ steps.pip-cache.outputs.dir }}
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-```
-
-### Using a script to get cache location
-
-> Note: This uses an internal pip API and may not always work
-```yaml
-- name: Get pip cache dir
- id: pip-cache
- run: |
-   python -c "from pip._internal.locations import USER_CACHE_DIR; print('::set-output name=dir::' + USER_CACHE_DIR)"
-
-- uses: actions/cache@v2
-  with:
-    path: ${{ steps.pip-cache.outputs.dir }}
-    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-    restore-keys: |
-      ${{ runner.os }}-pip-
-```
-
-## R - renv
-
-For renv, the cache directory will vary by OS. Look at https://rstudio.github.io/renv/articles/renv.html#cache
-
-Locations:
- - Ubuntu: `~/.local/share/renv`
- - macOS: `~/Library/Application Support/renv`
- - Windows: `%LOCALAPPDATA%/renv`
-
-### Simple example
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: ~/.local/share/renv
-    key: ${{ runner.os }}-renv-${{ hashFiles('**/renv.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-renv-
-```
-
-Replace `~/.local/share/renv` with the correct `path` if not using Ubuntu.
-
-### Multiple OS's in a workflow
-
-```yaml
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'Linux')
-  with:
-    path: ~/.local/share/renv
-    key: ${{ runner.os }}-renv-${{ hashFiles('**/renv.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-renv-
-
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'macOS')
-  with:
-    path: ~/Library/Application Support/renv
-    key: ${{ runner.os }}-renv-${{ hashFiles('**/renv.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-renv-
-
-- uses: actions/cache@v2
-  if: startsWith(runner.os, 'Windows')
-  with:
-    path: ~\AppData\Local\renv
-    key: ${{ runner.os }}-renv-${{ hashFiles('**/renv.lock') }}
-    restore-keys: |
-      ${{ runner.os }}-renv-
-```
-
-## Ruby - Bundler
-
-```yaml
-- uses: actions/cache@v2
   with:
     path: vendor/bundle
-    key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+    key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
     restore-keys: |
-      ${{ runner.os }}-gems-
+      ${{ runner.os }}-gem-
-```
-When dependencies are installed later in the workflow, we must specify the same path for the bundler.
-
-```yaml
-- name: Bundle install
-  run: |
-    bundle config path vendor/bundle
-    bundle install --jobs 4 --retry 3
 ```
 
 ## Rust - Cargo
 
 ```yaml
-- uses: actions/cache@v2
+- name: Cache cargo registry
+  uses: actions/cache@v1
   with:
-    path: |
+    path: ~/.cargo/registry
-      ~/.cargo/registry
+    key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
-      ~/.cargo/git
+- name: Cache cargo index
-      target
+  uses: actions/cache@v1
-    key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
-```
-
-## Scala - SBT
-
-```yaml
-- name: Cache SBT
-  uses: actions/cache@v2
   with:
-    path: | 
+    path: ~/.cargo/git
-      ~/.ivy2/cache
+    key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
-      ~/.sbt
+- name: Cache cargo build
-    key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
+  uses: actions/cache@v1
+  with:
+    path: target
+    key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
 ```
 
 ## Swift, Objective-C - Carthage
 
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
     path: Carthage
     key: ${{ runner.os }}-carthage-${{ hashFiles('**/Cartfile.resolved') }}
@@ -485,21 +134,10 @@ When dependencies are installed later in the workflow, we must specify the same
 ## Swift, Objective-C - CocoaPods
 
 ```yaml
-- uses: actions/cache@v2
+- uses: actions/cache@v1
   with:
     path: Pods
     key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
     restore-keys: |
       ${{ runner.os }}-pods-
 ```
-
-## Swift - Swift Package Manager
-
-```yaml
-- uses: actions/cache@v2
-  with:
-    path: .build
-    key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
-    restore-keys: |
-      ${{ runner.os }}-spm-
-```

jest.config.js

@@ -1,23 +1,20 @@
-require("nock").disableNetConnect();
-
 module.exports = {
-    clearMocks: true,
+  clearMocks: true,
-    moduleFileExtensions: ["js", "ts"],
+  moduleFileExtensions: ['js', 'ts'],
-    testEnvironment: "node",
+  testEnvironment: 'node',
-    testMatch: ["**/*.test.ts"],
+  testMatch: ['**/*.test.ts'],
-    testRunner: "jest-circus/runner",
+  testRunner: 'jest-circus/runner',
-    transform: {
+  transform: {
-        "^.+\\.ts$": "ts-jest"
+    '^.+\\.ts$': 'ts-jest'
-    },
+  },
-    verbose: true
+  verbose: true
-};
+}
 
-const processStdoutWrite = process.stdout.write.bind(process.stdout);
+const processStdoutWrite = process.stdout.write.bind(process.stdout)
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 process.stdout.write = (str, encoding, cb) => {
-    // Core library will directly call process.stdout.write for commands
+  // Core library will directly call process.stdout.write for commands
-    // We don't want :: commands to be executed by the runner during tests
+  // We don't want :: commands to be executed by the runner during tests
-    if (!str.match(/^::/)) {
+  if (!str.match(/^::/)) {
-        return processStdoutWrite(str, encoding, cb);
+    return processStdoutWrite(str, encoding, cb);
-    }
+  }
-};
+}

package.json

@@ -1,15 +1,15 @@
 {
   "name": "cache",
-  "version": "2.1.0",
+  "version": "1.0.1",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
   "scripts": {
-    "build": "tsc && ncc build -o dist/restore src/restore.ts && ncc build -o dist/save src/save.ts",
+    "build": "tsc",
     "test": "tsc --noEmit && jest --coverage",
-    "lint": "eslint **/*.ts --cache",
     "format": "prettier --write **/*.ts",
-    "format-check": "prettier --check **/*.ts"
+    "format-check": "prettier --check **/*.ts",
+    "release": "ncc build -o dist/restore src/restore.ts && ncc build -o dist/save src/save.ts && git add -f dist/"
   },
   "repository": {
     "type": "git",
@@ -26,26 +26,18 @@
     "@actions/core": "^1.2.0",
     "@actions/exec": "^1.0.1",
     "@actions/io": "^1.0.1",
-    "@actions/cache": "^1.0.1"
+    "typed-rest-client": "^1.5.0",
+    "uuid": "^3.3.3"
   },
   "devDependencies": {
     "@types/jest": "^24.0.13",
-    "@types/nock": "^11.1.0",
     "@types/node": "^12.0.4",
-    "@typescript-eslint/eslint-plugin": "^2.7.0",
+    "@types/uuid": "^3.4.5",
-    "@typescript-eslint/parser": "^2.7.0",
     "@zeit/ncc": "^0.20.5",
-    "eslint": "^6.6.0",
-    "eslint-config-prettier": "^6.5.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-jest": "^23.0.3",
-    "eslint-plugin-prettier": "^3.1.1",
-    "eslint-plugin-simple-import-sort": "^5.0.2",
     "jest": "^24.8.0",
     "jest-circus": "^24.7.1",
-    "nock": "^11.7.0",
+    "prettier": "1.18.2",
-    "prettier": "^1.19.1",
     "ts-jest": "^24.0.2",
-    "typescript": "^3.7.3"
+    "typescript": "^3.6.4"
   }
 }

src/cacheHttpClient.ts

@@ -0,0 +1,124 @@
+import * as core from "@actions/core";
+import * as fs from "fs";
+
+import { BearerCredentialHandler } from "typed-rest-client/Handlers";
+import { HttpClient } from "typed-rest-client/HttpClient";
+import { IHttpClientResponse } from "typed-rest-client/Interfaces";
+import { RestClient, IRequestOptions } from "typed-rest-client/RestClient";
+
+import { ArtifactCacheEntry } from "./contracts";
+
+export async function getCacheEntry(
+    keys: string[]
+): Promise<ArtifactCacheEntry | null> {
+    const cacheUrl = getCacheUrl();
+    const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+    const bearerCredentialHandler = new BearerCredentialHandler(token);
+
+    const resource = `_apis/artifactcache/cache?keys=${encodeURIComponent(
+        keys.join(",")
+    )}`;
+
+    const restClient = new RestClient("actions/cache", cacheUrl, [
+        bearerCredentialHandler
+    ]);
+
+    const response = await restClient.get<ArtifactCacheEntry>(
+        resource,
+        getRequestOptions()
+    );
+    if (response.statusCode === 204) {
+        return null;
+    }
+    if (response.statusCode !== 200) {
+        throw new Error(`Cache service responded with ${response.statusCode}`);
+    }
+    const cacheResult = response.result;
+    core.debug(`Cache Result:`);
+    core.debug(JSON.stringify(cacheResult));
+    if (!cacheResult || !cacheResult.archiveLocation) {
+        throw new Error("Cache not found.");
+    }
+
+    return cacheResult;
+}
+
+export async function downloadCache(
+    cacheEntry: ArtifactCacheEntry,
+    archivePath: string
+): Promise<void> {
+    const stream = fs.createWriteStream(archivePath);
+    const httpClient = new HttpClient("actions/cache");
+    const downloadResponse = await httpClient.get(cacheEntry.archiveLocation!);
+    await pipeResponseToStream(downloadResponse, stream);
+}
+
+async function pipeResponseToStream(
+    response: IHttpClientResponse,
+    stream: NodeJS.WritableStream
+): Promise<void> {
+    return new Promise(resolve => {
+        response.message.pipe(stream).on("close", () => {
+            resolve();
+        });
+    });
+}
+
+export async function saveCache(stream: NodeJS.ReadableStream, key: string) {
+    const cacheUrl = getCacheUrl();
+    const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+    const bearerCredentialHandler = new BearerCredentialHandler(token);
+
+    const resource = `_apis/artifactcache/cache/${encodeURIComponent(key)}`;
+    const postUrl = cacheUrl + resource;
+
+    const restClient = new RestClient("actions/cache", undefined, [
+        bearerCredentialHandler
+    ]);
+
+    const requestOptions = getRequestOptions();
+    requestOptions.additionalHeaders = {
+        "Content-Type": "application/octet-stream"
+    };
+
+    const response = await restClient.uploadStream<void>(
+        "POST",
+        postUrl,
+        stream,
+        requestOptions
+    );
+    if (response.statusCode !== 200) {
+        throw new Error(`Cache service responded with ${response.statusCode}`);
+    }
+
+    core.info("Cache saved successfully");
+}
+
+function getRequestOptions(): IRequestOptions {
+    const requestOptions: IRequestOptions = {
+        acceptHeader: createAcceptHeader("application/json", "5.2-preview.1")
+    };
+
+    return requestOptions;
+}
+
+function createAcceptHeader(type: string, apiVersion: string): string {
+    return `${type};api-version=${apiVersion}`;
+}
+
+function getCacheUrl(): string {
+    // Ideally we just use ACTIONS_CACHE_URL
+    let cacheUrl: string = (
+        process.env["ACTIONS_CACHE_URL"] ||
+        process.env["ACTIONS_RUNTIME_URL"] ||
+        ""
+    ).replace("pipelines", "artifactcache");
+    if (!cacheUrl) {
+        throw new Error(
+            "Cache Service Url not found, unable to restore cache."
+        );
+    }
+
+    core.debug(`Cache Url: ${cacheUrl}`);
+    return cacheUrl;
+}

src/constants.ts

@@ -1,22 +1,14 @@
-export enum Inputs {
+export namespace Inputs {
-    Key = "key",
+    export const Key = "key";
-    Path = "path",
+    export const Path = "path";
-    RestoreKeys = "restore-keys"
+    export const RestoreKeys = "restore-keys";
 }
 
-export enum Outputs {
+export namespace Outputs {
-    CacheHit = "cache-hit"
+    export const CacheHit = "cache-hit";
 }
 
-export enum State {
+export namespace State {
-    CachePrimaryKey = "CACHE_KEY",
+    export const CacheKey = "CACHE_KEY";
-    CacheMatchedKey = "CACHE_RESULT"
+    export const CacheResult = "CACHE_RESULT";
 }
-
-export enum Events {
-    Key = "GITHUB_EVENT_NAME",
-    Push = "push",
-    PullRequest = "pull_request"
-}
-
-export const RefKey = "GITHUB_REF";

src/contracts.d.ts

@@ -0,0 +1,6 @@
+export interface ArtifactCacheEntry {
+    cacheKey?: string;
+    scope?: string;
+    creationTime?: string;
+    archiveLocation?: string;
+}

src/restore.ts

@@ -1,59 +1,111 @@
-import * as cache from "@actions/cache";
 import * as core from "@actions/core";
+import { exec } from "@actions/exec";
+import * as io from "@actions/io";
 
-import { Events, Inputs, State } from "./constants";
+import * as fs from "fs";
+import * as path from "path";
+
+import * as cacheHttpClient from "./cacheHttpClient";
+import { Inputs, State } from "./constants";
 import * as utils from "./utils/actionUtils";
 
-async function run(): Promise<void> {
+async function run() {
     try {
         // Validate inputs, this can cause task failure
-        if (!utils.isValidEvent()) {
+        let cachePath = utils.resolvePath(
-            utils.logWarning(
+            core.getInput(Inputs.Path, { required: true })
-                `Event Validation Error: The event type ${
+        );
-                    process.env[Events.Key]
+        core.debug(`Cache Path: ${cachePath}`);
-                } is not supported because it's not tied to a branch or tag ref.`
+
+        const primaryKey = core.getInput(Inputs.Key, { required: true });
+        core.saveState(State.CacheKey, primaryKey);
+
+        const restoreKeys = core
+            .getInput(Inputs.RestoreKeys)
+            .split("\n")
+            .filter(x => x !== "");
+        const keys = [primaryKey, ...restoreKeys];
+
+        core.debug("Resolved Keys:");
+        core.debug(JSON.stringify(keys));
+
+        if (keys.length > 10) {
+            core.setFailed(
+                `Key Validation Error: Keys are limited to a maximum of 10.`
             );
             return;
         }
-
+        for (const key of keys) {
-        const primaryKey = core.getInput(Inputs.Key, { required: true });
+            if (key.length > 512) {
-        core.saveState(State.CachePrimaryKey, primaryKey);
+                core.setFailed(
-
+                    `Key Validation Error: ${key} cannot be larger than 512 characters.`
-        const restoreKeys = utils.getInputAsArray(Inputs.RestoreKeys);
+                );
-        const cachePaths = utils.getInputAsArray(Inputs.Path, {
+                return;
-            required: true
+            }
-        });
+            const regex = /^[^,]*$/;
+            if (!regex.test(key)) {
+                core.setFailed(
+                    `Key Validation Error: ${key} cannot contain commas.`
+                );
+                return;
+            }
+        }
 
         try {
-            const cacheKey = await cache.restoreCache(
+            const cacheEntry = await cacheHttpClient.getCacheEntry(keys);
-                cachePaths,
+            if (!cacheEntry) {
-                primaryKey,
-                restoreKeys
-            );
-            if (!cacheKey) {
                 core.info(
-                    `Cache not found for input keys: ${[
+                    `Cache not found for input keys: ${keys.join(", ")}.`
-                        primaryKey,
-                        ...restoreKeys
-                    ].join(", ")}`
                 );
                 return;
             }
 
-            // Store the matched cache key
+            let archivePath = path.join(
-            utils.setCacheState(cacheKey);
+                await utils.createTempDirectory(),
+                "cache.tgz"
+            );
+            core.debug(`Archive Path: ${archivePath}`);
 
-            const isExactKeyMatch = utils.isExactKeyMatch(primaryKey, cacheKey);
+            // Store the cache result
+            utils.setCacheState(cacheEntry);
+
+            // Download the cache from the cache entry
+            await cacheHttpClient.downloadCache(cacheEntry, archivePath);
+
+            io.mkdirP(cachePath);
+
+            // http://man7.org/linux/man-pages/man1/tar.1.html
+            // tar [-options] <name of the tar archive> [files or directories which to add into archive]
+            const args = ["-xz"];
+
+            const IS_WINDOWS = process.platform === "win32";
+            if (IS_WINDOWS) {
+                args.push("--force-local");
+                archivePath = archivePath.replace(/\\/g, "/");
+                cachePath = cachePath.replace(/\\/g, "/");
+            }
+            args.push(...["-f", archivePath, "-C", cachePath]);
+
+            const tarPath = await io.which("tar", true);
+            core.debug(`Tar Path: ${tarPath}`);
+
+            const archiveFileSize = fs.statSync(archivePath).size;
+            core.debug(`File Size: ${archiveFileSize}`);
+
+            await exec(`"${tarPath}"`, args);
+
+            const isExactKeyMatch = utils.isExactKeyMatch(
+                primaryKey,
+                cacheEntry
+            );
             utils.setCacheHitOutput(isExactKeyMatch);
 
-            core.info(`Cache restored from key: ${cacheKey}`);
+            core.info(
+                `Cache restored from key: ${cacheEntry && cacheEntry.cacheKey}`
+            );
         } catch (error) {
-            if (error.name === cache.ValidationError.name) {
+            core.warning(error.message);
-                throw error;
+            utils.setCacheHitOutput(false);
-            } else {
-                utils.logWarning(error.message);
-                utils.setCacheHitOutput(false);
-            }
         }
     } catch (error) {
         core.setFailed(error.message);

src/save.ts

@@ -1,26 +1,22 @@
-import * as cache from "@actions/cache";
 import * as core from "@actions/core";
+import { exec } from "@actions/exec";
 
-import { Events, Inputs, State } from "./constants";
+import * as io from "@actions/io";
+import * as fs from "fs";
+import * as path from "path";
+
+import * as cacheHttpClient from "./cacheHttpClient";
+import { Inputs, State } from "./constants";
 import * as utils from "./utils/actionUtils";
 
-async function run(): Promise<void> {
+async function run() {
     try {
-        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.`
-            );
-            return;
-        }
-
         const state = utils.getCacheState();
 
         // Inputs are re-evaluted before the post action, so we want the original key used for restore
-        const primaryKey = core.getState(State.CachePrimaryKey);
+        const primaryKey = core.getState(State.CacheKey);
         if (!primaryKey) {
-            utils.logWarning(`Error retrieving key from state.`);
+            core.warning(`Error retrieving key from state.`);
             return;
         }
 
@@ -31,23 +27,47 @@ async function run(): Promise<void> {
             return;
         }
 
-        const cachePaths = utils.getInputAsArray(Inputs.Path, {
+        let cachePath = utils.resolvePath(
-            required: true
+            core.getInput(Inputs.Path, { required: true })
-        });
+        );
+        core.debug(`Cache Path: ${cachePath}`);
 
-        try {
+        let archivePath = path.join(
-            await cache.saveCache(cachePaths, primaryKey);
+            await utils.createTempDirectory(),
-        } catch (error) {
+            "cache.tgz"
-            if (error.name === cache.ValidationError.name) {
+        );
-                throw error;
+        core.debug(`Archive Path: ${archivePath}`);
-            } else if (error.name === cache.ReserveCacheError.name) {
+
-                core.info(error.message);
+        // http://man7.org/linux/man-pages/man1/tar.1.html
-            } else {
+        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-                utils.logWarning(error.message);
+        const args = ["-cz"];
-            }
+        const IS_WINDOWS = process.platform === "win32";
+        if (IS_WINDOWS) {
+            args.push("--force-local");
+            archivePath = archivePath.replace(/\\/g, "/");
+            cachePath = cachePath.replace(/\\/g, "/");
         }
+
+        args.push(...["-f", archivePath, "-C", cachePath, "."]);
+
+        const tarPath = await io.which("tar", true);
+        core.debug(`Tar Path: ${tarPath}`);
+        await exec(`"${tarPath}"`, args);
+
+        const fileSizeLimit = 400 * 1024 * 1024; // 400MB
+        const archiveFileSize = fs.statSync(archivePath).size;
+        core.debug(`File Size: ${archiveFileSize}`);
+        if (archiveFileSize > fileSizeLimit) {
+            core.warning(
+                `Cache size of ${archiveFileSize} bytes is over the 400MB limit, not saving cache.`
+            );
+            return;
+        }
+
+        const stream = fs.createReadStream(archivePath);
+        await cacheHttpClient.saveCache(stream, primaryKey);
     } catch (error) {
-        utils.logWarning(error.message);
+        core.warning(error.message);
     }
 }
 

src/utils/actionUtils.ts

@@ -1,58 +1,81 @@
 import * as core from "@actions/core";
+import * as io from "@actions/io";
+import * as os from "os";
+import * as path from "path";
+import * as uuidV4 from "uuid/v4";
 
-import { Outputs, RefKey, State } from "../constants";
+import { Outputs, State } from "../constants";
+import { ArtifactCacheEntry } from "../contracts";
 
-export function isExactKeyMatch(key: string, cacheKey?: string): boolean {
+// From https://github.com/actions/toolkit/blob/master/packages/tool-cache/src/tool-cache.ts#L23
+export async function createTempDirectory(): Promise<string> {
+    const IS_WINDOWS = process.platform === "win32";
+
+    let tempDirectory: string = process.env["RUNNER_TEMP"] || "";
+
+    if (!tempDirectory) {
+        let baseLocation: string;
+        if (IS_WINDOWS) {
+            // On Windows use the USERPROFILE env variable
+            baseLocation = process.env["USERPROFILE"] || "C:\\";
+        } else {
+            if (process.platform === "darwin") {
+                baseLocation = "/Users";
+            } else {
+                baseLocation = "/home";
+            }
+        }
+        tempDirectory = path.join(baseLocation, "actions", "temp");
+    }
+    const dest = path.join(tempDirectory, uuidV4.default());
+    await io.mkdirP(dest);
+    return dest;
+}
+
+export function isExactKeyMatch(
+    key: string,
+    cacheResult?: ArtifactCacheEntry
+): boolean {
     return !!(
-        cacheKey &&
+        cacheResult &&
-        cacheKey.localeCompare(key, undefined, {
+        cacheResult.cacheKey &&
+        cacheResult.cacheKey.localeCompare(key, undefined, {
             sensitivity: "accent"
         }) === 0
     );
 }
 
-export function setCacheState(state: string): void {
+export function setOutputAndState(
-    core.saveState(State.CacheMatchedKey, state);
+    key: string,
+    cacheResult?: ArtifactCacheEntry
+) {
+    setCacheHitOutput(isExactKeyMatch(key, cacheResult));
+    // Store the cache result if it exists
+    cacheResult && setCacheState(cacheResult);
 }
 
-export function setCacheHitOutput(isCacheHit: boolean): void {
+export function getCacheState(): ArtifactCacheEntry | undefined {
+    const stateData = core.getState(State.CacheResult);
+    core.debug(`State: ${stateData}`);
+    return (stateData && JSON.parse(stateData)) as ArtifactCacheEntry;
+}
+
+export function setCacheState(state: ArtifactCacheEntry) {
+    core.saveState(State.CacheResult, JSON.stringify(state));
+}
+
+export function setCacheHitOutput(isCacheHit: boolean) {
     core.setOutput(Outputs.CacheHit, isCacheHit.toString());
 }
 
-export function setOutputAndState(key: string, cacheKey?: string): void {
+export function resolvePath(filePath: string): string {
-    setCacheHitOutput(isExactKeyMatch(key, cacheKey));
+    if (filePath[0] === "~") {
-    // Store the matched cache key if it exists
+        const home = os.homedir();
-    cacheKey && setCacheState(cacheKey);
+        if (!home) {
-}
+            throw new Error("Unable to resolve `~` to HOME");
-
+        }
-export function getCacheState(): string | undefined {
+        return path.join(home, filePath.slice(1));
-    const cacheKey = core.getState(State.CacheMatchedKey);
-    if (cacheKey) {
-        core.debug(`Cache state/key: ${cacheKey}`);
-        return cacheKey;
     }
 
-    return undefined;
+    return path.resolve(filePath);
-}
-
-export function logWarning(message: string): void {
-    const warningPrefix = "[warning]";
-    core.info(`${warningPrefix}${message}`);
-}
-
-// Cache token authorized for all events that are tied to a ref
-// See GitHub Context https://help.github.com/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#github-context
-export function isValidEvent(): boolean {
-    return RefKey in process.env && Boolean(process.env[RefKey]);
-}
-
-export function getInputAsArray(
-    name: string,
-    options?: core.InputOptions
-): string[] {
-    return core
-        .getInput(name, options)
-        .split("\n")
-        .map(s => s.trim())
-        .filter(x => x !== "");
 }

src/utils/testUtils.ts

@@ -1,29 +1,7 @@
-import { Inputs } from "../constants";
-
-// See: https://github.com/actions/toolkit/blob/master/packages/core/src/core.ts#L67
 function getInputName(name: string): string {
     return `INPUT_${name.replace(/ /g, "_").toUpperCase()}`;
 }
 
-export function setInput(name: string, value: string): void {
+export function setInput(name: string, value: string) {
     process.env[getInputName(name)] = value;
 }
-
-interface CacheInput {
-    path: string;
-    key: string;
-    restoreKeys?: string[];
-}
-
-export function setInputs(input: CacheInput): void {
-    setInput(Inputs.Path, input.path);
-    setInput(Inputs.Key, input.key);
-    input.restoreKeys &&
-        setInput(Inputs.RestoreKeys, input.restoreKeys.join("\n"));
-}
-
-export function clearInputs(): void {
-    delete process.env[getInputName(Inputs.Path)];
-    delete process.env[getInputName(Inputs.Key)];
-    delete process.env[getInputName(Inputs.RestoreKeys)];
-}