api_function_registergithubactionstoolcachefile

Register-GitHubActionsToolCacheFile

🔘 NodeJS Wrapper

This dependents and requires NodeJS to invoke.

• Type: Function
• In Version: >= v0.5.0

Register a tool file to cache and install in the tool cache.

• Register-GitHubActionsToolCacheFile
    [-Source] <String>
    [-Target] <String>
    [-Name] <String>
    [-Version] <SemVer>
    [-Architecture <String>]

Parameter

Architecture

[Optional] <String> Architecture for the tool; Default to the architecture of the current machine.

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

Name

<String> Name for the tool.

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

Source

<String> Path of the tool file.

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

Target

<String> Path for the tool file in the tool cache.

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

Version

<SemVer> Version for the tool, by Semantic Versioning (SemVer) 2.0.0.

• Position: 3
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • (< v2.0.0) V
  • (< v2.0.0) Ver

Output

<String> Absolute path of the tool cached.