From 9a3c0051620fd66c506b94d8ee2d25ebddc3e86c Mon Sep 17 00:00:00 2001 From: Jan Jurzitza Date: Fri, 15 Nov 2019 22:12:36 +0100 Subject: [PATCH] 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. --- packages/tool-cache/src/tool-cache.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/tool-cache/src/tool-cache.ts b/packages/tool-cache/src/tool-cache.ts index 9ab2deb5..c932ab77 100644 --- a/packages/tool-cache/src/tool-cache.ts +++ b/packages/tool-cache/src/tool-cache.ts @@ -183,11 +183,11 @@ export async function extract7z( } /** - * Extract a tar + * Extract a compressed tar archive * * @param file path to the tar * @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 */ export async function extractTar(