Merge pull request #1 from hipcamp/documentation

Update README

README.md

@@ -1,34 +1,3 @@
-# cache
-
-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>
-
-## 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
-    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
@@ -39,13 +8,15 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory
 * `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
+* `bucket` - aws s3 bucket
+* `access-key-id` - aws access key id *OPTIONAL*
+* `secret-access-key` - aws secret access key *OPTIONAL*
 
 ### Outputs
 
 * `cache-hit` - A boolean value to indicate an exact match was found for the key
 
 > 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. 
 
@@ -54,121 +25,114 @@ See [Matching a cache key](https://help.github.com/en/actions/configuring-and-ma
 ### Example workflow
 
 ```yaml
-name: Caching Primes
-
+name: Caching Node Modules
 on: push
-
 jobs:
-  build:
+  build-with-cache:
+    name: NPM Install with Cache
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - uses: hipcamp/cache@v0.13.0
+        id: node-cache
+        with:
+          bucket: [your cache bucket]
+          path: node_modules
+          key: node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            node-
+      - run: npm install
+```
 
-    - name: Cache Primes
-      id: cache-primes
-      uses: actions/cache@v2
-      with:
-        path: prime-numbers
-        key: ${{ runner.os }}-primes
+## Skipping steps based on cache-hit
 
-    - name: Generate Prime Numbers
-      if: steps.cache-primes.outputs.cache-hit != 'true'
-      run: /generate-primes.sh -d prime-numbers
+Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
 
-    - name: Use Prime Numbers
-      run: /primes.sh -d prime-numbers
+Example:
+```yaml
+steps:
+  - uses: actions/checkout@v2
+  - uses: actions/cache@v2
+    id: cache
+    with:
+      path: path/to/dependencies
+      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+  - name: Install Dependencies
+    if: steps.cache.outputs.cache-hit != 'true'
+    run: /install.sh
 ```
 
-## Implementation Examples
+> Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
 
-Every programming language and framework has its own way of caching.
+## How to Contribute
 
-See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
+> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
 
-- [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)
-- [Python - pipenv](./examples.md#python---pipenv)
-- [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)
+Install the dependencies  
+```bash
+$ npm install
+```
 
-## Creating a cache key
+Build the typescript and package it for distribution
+```bash
+$ npm run build && npm run package
+```
 
-A cache key can include any of the contexts, functions, literals, and operators supported by GitHub Actions.
+Run the tests :heavy_check_mark:  
+```bash
+$ npm test
 
-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.
+ PASS  ./index.test.js
+  ✓ throws invalid number (3ms)
+  ✓ wait 500 ms (504ms)
+  ✓ test runs (95ms)
 
-```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:
+## Change action.yml
 
-```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
+The action.yml contains defines the inputs and output for your action.
 
-  - uses: actions/cache@v2
-    with:
-      path: path/to/dependencies
-      key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
-```
+Update the action.yml with your name, description, inputs and outputs for your action.
 
-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)
+See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
 
-## Cache Limits
+## Change the Code
 
-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.
+Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
 
-## Skipping steps based on cache-hit
+```javascript
+import * as core from '@actions/core';
+...
 
-Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.
+async function run() {
+  try { 
+      ...
+  } 
+  catch (error) {
+    core.setFailed(error.message);
+  }
+}
 
-Example:
-```yaml
-steps:
-  - uses: actions/checkout@v2
+run()
+```
 
-  - uses: actions/cache@v2
-    id: cache
-    with:
-      path: path/to/dependencies
-      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
 
-  - name: Install Dependencies
-    if: steps.cache.outputs.cache-hit != 'true'
-    run: /install.sh
-```
+## Publish to a Distribution Branch
 
-> Note: The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
+Actions are run from GitHub repos so we will checkin the packed dist folder. 
+
+```bash
+$ npm run all
+$ git add -A
+$ git commit -m "your commit message"
+$ git tag v[version from package.json]
+$ git push origin v[version from package.json]
+```
 
-## 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.
+Your action is now published! :rocket: 
 
-## License
-The scripts and documentation in this project are released under the [MIT License](LICENSE)
+See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)