api_function_savegithubactionscache

Save-GitHubActionsCache

🔘 NodeJS Wrapper: This dependents and requires NodeJS to invoke.

• Type: Function
• In Version: >= v0.5.0
• Alias:
  • Export-GitHubActionsCache

Save cache to share with the future jobs and/or workflows.

• # >= v2.0.0
  Save-GitHubActionsCache
    [-Path] <String[]>
    [-Key] <String>
    [-UploadChunkSize <UInt32>]
    [-UploadConcurrency <Byte>]

• # < v2.0.0; Parameter Set: Path (Default)
  Save-GitHubActionsCache
    [-Key] <String>
    [-Path] <String[]>
    [-UploadChunkSize <UInt32>]
    [-UploadConcurrency <Byte>]

• # < v2.0.0; Parameter Set: LiteralPath
  Save-GitHubActionsCache
    [-Key] <String>
    -LiteralPath <String[]>
    [-UploadChunkSize <UInt32>]
    [-UploadConcurrency <Byte>]

Parameter

Key

<String> Key of the cache.

• Parameter Set: (< v2.0.0)
  • LiteralPath
  • Path
• Position:
  • (>= v2.0.0) 1
  • (< v2.0.0) 0
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Name

Path

• (>= v2.0.0) <String[]> Paths of the cache, support Glob.
• (< v2.0.0) <String[]> Paths of the cache.

•

• Parameter Set: (< v2.0.0) Path
• Position:
  • (>= v2.0.0) 0
  • (< v2.0.0) 1
• Accept Pipeline Input:
  • (>= v2.0.0) True ✔️
  • (< v2.0.0) False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: True ✔️
• Alias:
  • (< v2.0.0) File
  • (< v2.0.0) Files
  • Paths

UploadChunkSize

• (>= v2.0.0) [Optional] <UInt32> Maximum chunk size for upload the cache, by byte.

• (< v2.0.0) [Optional] <UInt32> Maximum chunk size of the cache, by KB in range 1KB~1GB (i.e.: 1~1048576).

• Parameter Set: (< v2.0.0)

  • LiteralPath
  • Path

• Position: Named

• Accept Pipeline Input: False ❌

• Accept Pipeline Input By Property Name: True ✔️

• Accept Wildcard Characters: False ❌

• Alias:

  • ChunkSize
  • ChunkSizes
  • UploadChunkSizes

UploadConcurrency

[Optional] <Byte> Number of parallel uploads of the cache.

• Parameter Set: (< v2.0.0)
  • LiteralPath
  • Path
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Concurrency

LiteralPath

👎 Deprecated: This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

(< v2.0.0) <String[]> Literal paths of the cache.

• Parameter Set: LiteralPath
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • LiteralFile
  • LiteralFiles
  • LiteralPaths
  • LP
  • PSPath
  • PSPaths

Output

<UInt64> ID of the cache.