api_function_exportgithubactionsartifact

Export-GitHubActionsArtifact

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

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

Export artifact to share with all of the subsequent jobs in the current workflow run, and/or store it.

• # >= v2.0.0; Parameter Set: Path (Default)
  Export-GitHubActionsArtifact
    [-Name] <String>
    [-Path] <String[]>
    [-RootDirectory <String>]
    [-RetentionDays <Byte>]
    [-FailFast]

• # >= v2.0.0; Parameter Set: LiteralPath
  Export-GitHubActionsArtifact
    [-Name] <String>
    -LiteralPath <String[]>
    [-RootDirectory <String>]
    [-RetentionDays <Byte>]
    [-FailFast]

• # < v2.0.0; Parameter Set: Path (Default)
  Export-GitHubActionsArtifact
    [-Name] <String>
    [-Path] <String[]>
    [-RootDirectory <String>]
    [-ContinueOnError]
    [-RetentionDays <Int16>]

• # < v2.0.0; Parameter Set: LiteralPath
  Export-GitHubActionsArtifact
    [-Name] <String>
    -LiteralPath <String[]>
    [-RootDirectory <String>]
    [-ContinueOnError]
    [-RetentionDays <Int16>]

Parameter

FailFast

(>= v2.0.0) [Optional] <Switch> Whether to stop export artifact if any of file fail to export due to any of error.

By default, the failed files will skip and ignore, and all of the queued files will still export; The partial artifact will have all of the files except the failed files.

When enable, export will stop, include all of the queued files; The partial artifact will have files up until the failure.

A partial artifact will always associate and available at the end, and the size reported will be the amount of storage that the organization or user will charge for this partial artifact.

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

LiteralPath

<String[]> Literal path 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

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[]> Path of the files that need to export as artifact.

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

RetentionDays

• (>= v2.0.0) [Optional] <Byte> Retention days of the artifact, override the default value.
• (v1.7.X) [Optional] <Int16> Retention days of the artifact, in range 1~364.

•

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

RootDirectory

[Optional] <String> Absolute literal path of the 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:
  • BaseRoot
  • Root

ContinueOnError

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

(< v2.0.0) [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:
  • ContinueOnIssue

Output

<PSCustomObject> Metadata of the exported artifact.

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