api_function_getgithubactionsartifact

Get-GitHubActionsArtifact

🔘 NodeJS Wrapper

This dependents and requires NodeJS to invoke.

🔬 Partial Implementation

This implementation is partial, for more information, please visit https://github.com/hugoalh-studio/ghactions-toolkit-powershell/issues/177.

• Type: Function
• In Version: >= v2.1.0

Get artifact that shared from the previous jobs in the current workflow run.

• # Parameter Set: Single (Default)
  Get-GitHubActionsArtifact
    [-Name] <String>

• # Parameter Set: All
  Get-GitHubActionsArtifact
    -All
    [-Latest]

Parameter

All

<Switch> Whether to get all of the artifacts that shared the data from the past jobs in the same workflow.

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

Latest

[Optional] <Switch> Whether to filter the workflow run's artifacts to the latest by name. In the case of reruns, this can be useful to avoid duplicates.

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

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 artifacts.
  • [*].CreateAt: <DateTime> Create time of the artifact.
  • [*].Id: <UInt64> Id of the artifact.
  • [*].Name: <String> Name of the artifact.
  • [*].Size: <UInt64> Size of the artifact, by bytes.
• Single: <PSCustomObject> Metadata of the artifact.
  • CreateAt: <DateTime> Create time of the artifact.
  • Id: <UInt64> Id of the artifact.
  • Name: <String> Name of the artifact.
  • Size: <UInt64> Size of the artifact, by bytes.