actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code
toolkit/packages/tool-cache
History
Arthur Baars 57d20b4db4
tool-cache: make extract functions quiet by default and more verbose if `core.isDebug` is set (#206) 
* tool-cache: make unzip and 7z extract quiet by default

This avoids spamming the log when unzipping large archives.

* tool-cache: make tar, unzip and 7z verbose when `core.isDebug`

Make the extract function print the list of extracted file if
the action is run in debug mode.
 		2020-04-29 11:33:01 -04:00
..
__tests__ tool-cache: make extract functions quiet by default and more verbose if `core.isDebug` is set (#206) 2020-04-29 11:33:01 -04:00
scripts use zip and unzip from path (#161) 2019-09-24 17:07:08 -04:00
src tool-cache: make extract functions quiet by default and more verbose if `core.isDebug` is set (#206) 2020-04-29 11:33:01 -04:00
README.md Update tool cache docs (#347) 2020-02-26 11:43:55 -05:00
RELEASES.md bump tool-cache's http-client to 1.0.8 (#429) 2020-04-23 21:12:00 -04:00
package-lock.json bump tool-cache's http-client to 1.0.8 (#429) 2020-04-23 21:12:00 -04:00
package.json bump tool-cache's http-client to 1.0.8 (#429) 2020-04-23 21:12:00 -04:00
tsconfig.json
…

README.md

@actions/tool-cache

Functions necessary for downloading and caching tools.

Usage

Download

You can use this to download tools (or other files) from a download URL:

const tc = require('@actions/tool-cache');

const node12Path = await tc.downloadTool('https://nodejs.org/dist/v12.7.0/node-v12.7.0-linux-x64.tar.gz');

Extract

These can then be extracted in platform specific ways:

const tc = require('@actions/tool-cache');

if (process.platform === 'win32') {
  const node12Path = await tc.downloadTool('https://nodejs.org/dist/v12.7.0/node-v12.7.0-win-x64.zip');
  const node12ExtractedFolder = await tc.extractZip(node12Path, 'path/to/extract/to');

  // Or alternately
  const node12Path = await tc.downloadTool('https://nodejs.org/dist/v12.7.0/node-v12.7.0-win-x64.7z');
  const node12ExtractedFolder = await tc.extract7z(node12Path, 'path/to/extract/to');
}
else {
  const node12Path = await tc.downloadTool('https://nodejs.org/dist/v12.7.0/node-v12.7.0-linux-x64.tar.gz');
  const node12ExtractedFolder = await tc.extractTar(node12Path, 'path/to/extract/to');
}

Cache

Finally, you can cache these directories in our tool-cache. This is useful if you want to switch back and forth between versions of a tool, or save a tool between runs for self-hosted runners.

You'll often want to add it to the path as part of this step:

const tc = require('@actions/tool-cache');
const core = require('@actions/core');

const node12Path = await tc.downloadTool('https://nodejs.org/dist/v12.7.0/node-v12.7.0-linux-x64.tar.gz');
const node12ExtractedFolder = await tc.extractTar(node12Path, 'path/to/extract/to');

const cachedPath = await tc.cacheDir(node12ExtractedFolder, 'node', '12.7.0');
core.addPath(cachedPath);

You can also cache files for reuse.

const tc = require('@actions/tool-cache');

const cachedPath = await tc.cacheFile('path/to/exe', 'destFileName.exe', 'myExeName', '1.1.0');

Find

Finally, you can find directories and files you've previously cached:

const tc = require('@actions/tool-cache');
const core = require('@actions/core');

const nodeDirectory = tc.find('node', '12.x', 'x64');
core.addPath(nodeDirectory);

You can even find all cached versions of a tool:

const tc = require('@actions/tool-cache');

const allNodeVersions = tc.findAllVersions('node');
console.log(`Versions of node available: ${allNodeVersions}`);