api_function_exportgithubactionsartifact

Export-GitHubActionsArtifact

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

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

Description

# Parameter Set: LiteralPath
Export-GitHubActionsArtifact
  [-Name] <String>
  -LiteralPath <String[]>
  [-BaseRoot <String>]
  [-ContinueOnIssue]
  [-RetentionTime <Int16>]

# Parameter Set: Path (Default)
Export-GitHubActionsArtifact
  [-Name] <String>
  [-Path] <String[]>
  [-BaseRoot <String>]
  [-ContinueOnIssue]
  [-RetentionTime <Int16>]

Export artifact to persist the data and/or share with the future jobs in the same workflow.

Parameter

BaseRoot

[Optional] <String> Absolute literal path of the base root directory of the files for control files structure.

• Parameter Set:
  • LiteralPath
  • Path
• Default Value:

  $Env:GITHUB_WORKSPACE

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

ContinueOnIssue

[Optional] <Switch> Whether the export should continue in the event of files fail to export; If not set and issue is encountered, export will stop and queued files will not export, the partial artifact availables which include files up until the issue; If set and issue is encountered, the issue file will ignore and skip, and queued files will still export, the partial artifact availables which include everything but exclude issue files.

• Parameter Set:
  • LiteralPath
  • Path
• Position: Named
• Accept Pipeline Input By Property Name: True ✔
• Alias:
  • ContinueOnError

LiteralPath

<String[]> Literal paths of the files that need to export as artifact.

• 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

⚠ Important: Previously, this parameter did accept pipeline input, but often cause issues, avoid if possible.

Name

<String> Name of the artifact.

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

Path

<String[]> Paths of the files that need to export as artifact.

• Parameter Set: Path
• Position: 1
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔
• Accept Wildcard Characters: True ✔
• Alias:
  • File
  • Files
  • Paths

⚠ Important: Previously, this parameter did accept pipeline input, but often cause issues, avoid if possible.

RetentionTime

• (>= v1.6.0) [Optional] <Int16> Retention time of the artifact, by days in range 1~364.
• (< v1.6.0) [Optional] <Byte> Retention time of the artifact, by days in range 1~90.

•

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔
• Alias:
  • RetentionDay

Output

<PSCustomObject> Metadata of the exported artifact.

• Name: <String> Name of the exported artifact.
• Item / Items: <String[]> Items of the exported artifact.
• Size / Sizes: <UInt> Sizes of the exported artifact.
• FailedItem / FailedItems: <String[]> Failed items of the exported artifact.