api_function_exportgithubactionsartifact

Export-GitHubActionsArtifact

👀 Looking For Something Else

Looking for legacy Export-GitHubActionsArtifact? That is moved to here!

🔘 NodeJS Wrapper

This dependents and requires NodeJS to invoke.

• Type: Function
• In Version: >= v2.0.0
• Alias:
  • Save-GitHubActionsArtifact

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

• # Parameter Set: Path (Default)
  Export-GitHubActionsArtifact
    [-Name] <String>
    [-Path] <String[]>
    [-RootDirectory <String>]
    [-CompressionLevel <Int16>]
    [-RetentionDays <Byte>]

• # Parameter Set: LiteralPath
  Export-GitHubActionsArtifact
    [-Name] <String>
    -LiteralPath <String[]>
    [-RootDirectory <String>]
    [-CompressionLevel <Int16>]
    [-RetentionDays <Byte>]

Parameter

CompressionLevel

(>= v2.1.0) [Optional] <Int16> Level of compression for Zlib to be applied to the artifact archive. The value can range from 0 to 9.

• 0: No compression
• 1: Best speed
• 6: Default compression (same as GNU Gzip)
• 9: Best compression

Higher levels will result in better compression, but will take longer to complete. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.

• Parameter Set:
  • LiteralPath
  • Path
• Position: Named
• Accept Pipeline Input: False ❌
• 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: True ✔️
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: True ✔️
• Alias:
  • File
  • Files
  • Paths

RetentionDays

[Optional] <Byte> Retention days of the artifact, override the default value.

• 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

FailFast

👎 Deprecated

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

(< v2.1.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 ✔️

Output

<PSCustomObject> Metadata of the exported artifact.

• (>= v2.1.0)
  • Id: <UInt> ID of the exported artifact. Not provided if no artifact was uploaded.
  • Size: <UInt> Size of the exported artifact, by bytes. Not provided if no artifact was uploaded.
• (< v2.1.0)
  • Name: <String> Name of the exported artifact.
  • Items: <String[]> Items of the exported artifact.
  • Size: <UInt> Size of the exported artifact, by bytes.
  • FailedItems: <String[]> Failed items of the exported artifact.