actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Clarify that extractTar extracts gzipped tars (#134) 

The default downloadTool implementation strips the filename so when passing it to the extractTar function, it doesn't have a way of knowing the format without manually specifying it. However what the extractTar function arguments meant and how to specify them wasn't clear before reading the source code, so the documentation here got updated to reflect that.
pull/225/head
Jan Jurzitza 2019-11-15 22:12:36 +01:00 committed by eric sciple
parent 225370fc48
commit 9a3c005162
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/tool-cache/src/tool-cache.ts
View File

@ -183,11 +183,11 @@ export async function extract7z(
} }
/** /**
* Extract a tar * Extract a compressed tar archive
* *
* @param file path to the tar * @param file path to the tar
* @param dest destination directory. Optional. * @param dest destination directory. Optional.
* @param flags flags for the tar. Optional. * @param flags flags for the tar command to use for extraction. Defaults to 'xz' (extracting gzipped tars). Optional.
* @returns path to the destination directory * @returns path to the destination directory
*/ */
export async function extractTar( export async function extractTar(