api_function_importgithubactionsartifact

Import-GitHubActionsArtifact

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

• Type: Function
• In Version: >= v0.5.0
• Alias:
  • Restore-GitHubActionsArtifact

Description

# Parameter Set: All
Import-GitHubActionsArtifact
  -All
  [-Destination <String>]

# Parameter Set: Single (Default)
Import-GitHubActionsArtifact
  [-Name] <String>
  [-CreateSubfolder]
  [-Destination <String>]

Import artifact that shared the data from the past jobs in the same workflow.

Parameter

All

<Switch> Whether to import all of the artifacts that shared the data from the past jobs in the same workflow; Always create subfolders.

• Parameter Set: All
• Position: Named
• Accept Pipeline Input By Property Name: False ❌

CreateSubfolder

[Optional] <Switch> Whether to create a subfolder with artifact name and put the data into there.

• Parameter Set: Single
• Position: Named
• Accept Pipeline Input By Property Name: True ✔️

Destination

[Optional] <String> Absolute literal path of the destination of the artifact(s).

• Parameter Set:
  • All
  • Single
• Default Value:

  $Env:GITHUB_WORKSPACE

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

Name

<String> Name of the artifact.

• Parameter Set: Single
• Position: 0
• Accept Pipeline Input: True ✔️
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌

Output

• All: <PSCustomObject[]> Metadata of the imported artifacts.
  • [*].Name: Name of the artifact.
  • [*].Path: Absolute path of the destination of the artifact.
• Single: <PSCustomObject> Metadata of the imported artifact.
  • Name: Name of the artifact.
  • Path: Absolute path of the destination of the artifact.