Merge branch 'release-v1'

Author: seoljiwon

.github/workflows/test.yml

@@ -1,105 +1,33 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
+# Local Cache javascript action
 
-# Create a JavaScript Action using TypeScript
+This action caches artifacts to improve workflow execution time on self hosted machine.
+Artifacts are cached in the /tmp/.cache.
 
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+## Inputs
 
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
+### `base`
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+**Optional** A top directory to cache and restore.
 
-## Create an action from this template
+### `path`
 
-Click the `Use this Template` and provide the new repo details for your action
+**Required** A directory to cache and restore.
 
-## Code in Main
+### `key`
 
-> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
+**Required** An explicit key for a cache entry.
 
-Install the dependencies  
-```bash
-$ npm install
-```
-
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run package
-```
-
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
+## Outputs
 
-## Change action.yml
+### `cache-hit`
 
-The action.yml defines the inputs and output for your action.
+Cache hit or not
 
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
-
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket: 
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
+## Example usage
 
 ```yaml
-uses: ./
+uses: corca-ai/local-cache@1
 with:
-  milliseconds: 1000
+  path: node_modules
+  key: ${{ hashFiles('yarn.lock') }}
 ```
-
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
-
-## Usage:
-
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action

README.md

@@ -1,11 +1,21 @@
-name: 'Your name here'
-description: 'Provide a description here'
-author: 'Your name or organization here'
+name: 'local-cache'
+description: 'Cache artifacts to improve workflow execution time on self hosted machine'
 inputs:
-  milliseconds: # change this
+  base:
+    description: 'A top directory to cache and restore'
+    required: false
+    default: '/home/ubuntu/.cache'
+  path:
+    description: 'A directory to cache and restore.'
     required: true
-    description: 'input description here'
-    default: 'default value if applicable'
+  key:
+    description: 'An explicit key for a cache entry.'
+    required: true
+outputs:
+  cache-hit:
+    description: 'Cache hit or not'
 runs:
   using: 'node16'
-  main: 'dist/index.js'
+  main: 'dist/restore/index.js'
+  post: 'dist/save/index.js'
+  post-if: success()