api_function_expandgithubactionstoolcachecompressedfile

Expand-GitHubActionsToolCacheCompressedFile

🔘 NodeJS Wrapper

This dependents and requires NodeJS to invoke.

• Type: Function
• In Version: >= v0.5.0
• Alias:
  • Expand-GitHubActionsToolCacheArchive

Expand an archive or a compressed file.

• Expand-GitHubActionsToolCacheCompressedFile
    [-File] <String>
    [-Destination <String>]
    [-Method <String>]
    [-7zrPath <String>]
    [-Flag <String[]>]

Parameter

7zrPath

[Optional] <String> Literal path of the 7zr application, for long path support (only when parameter Method is 7z).

Most of the .7z archives do not have this problem, if .7z archive contains very long path, pass the path to 7zr which will gracefully handle long paths, by default 7zdec is used because it is a very small program and is bundled with the GitHub Actions NodeJS toolkit, however it does not support long paths, 7zr is the reduced command line interface, it is smaller than the full command line interface, and it does support long paths, at the time of this writing, it is freely available from the LZMA SDK that is available on the 7-Zip website, be sure to check the current license agreement, if 7zr is bundled with your action, then the path to 7zr can be pass to this function.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌

Destination

[Optional] <String> Path for the expand destination.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Target

File

<String> Path of the archive or the compressed file.

• Position: 0
• Accept Pipeline Input: True ✔️
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Source

Flag

[Optional] <String[]> Flags to use for expand (only when parameter Method is Tar or Xar).

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Flags

Method

[Optional] <String> Method to expand the archive or the compressed file; Define this parameter will enforce to use the defined method.

• Accept Value:
  • 7z
  • Tar
  • Xar
  • Zip
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌

Output

<String> Absolute path of the expand destination.