5.6 KiB
@actions/artifact / ArtifactClient
Interface: ArtifactClient
Generic interface for the artifact client.
Implemented by
Table of contents
Methods
Methods
deleteArtifact
▸ deleteArtifact(artifactName, options?): Promise<DeleteArtifactResponse>
Delete an Artifact
If options.findBy is specified, this will use the public Delete Artifact API https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#delete-an-artifact
Parameters
| Name | Type | Description |
|---|---|---|
artifactName |
string |
The name of the artifact to delete |
options? |
FindOptions |
Extra options that allow for the customization of the delete behavior |
Returns
Promise<DeleteArtifactResponse>
single DeleteArtifactResponse object
Defined in
downloadArtifact
▸ downloadArtifact(artifactId, options?): Promise<DownloadArtifactResponse>
Downloads an artifact and unzips the content.
If options.findBy is specified, this will use the public Download Artifact API https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#download-an-artifact
Parameters
| Name | Type | Description |
|---|---|---|
artifactId |
number |
The id of the artifact to download |
options? |
DownloadArtifactOptions & FindOptions |
Extra options that allow for the customization of the download behavior |
Returns
Promise<DownloadArtifactResponse>
single DownloadArtifactResponse object
Defined in
getArtifact
▸ getArtifact(artifactName, options?): Promise<GetArtifactResponse>
Finds an artifact by name. If there are multiple artifacts with the same name in the same workflow run, this will return the latest. If the artifact is not found, it will throw.
If options.findBy is specified, this will use the public List Artifacts API with a name filter which can get artifacts from other runs.
https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#list-workflow-run-artifacts
@actions/artifact v2+ does not allow for creating multiple artifacts with the same name in the same workflow run.
It is possible to have multiple artifacts with the same name in the same workflow run by using old versions of upload-artifact (v1,v2 and v3), @actions/artifact < v2 or it is a rerun.
If there are multiple artifacts with the same name in the same workflow run this function will return the first artifact that matches the name.
Parameters
| Name | Type | Description |
|---|---|---|
artifactName |
string |
The name of the artifact to find |
options? |
FindOptions |
Extra options that allow for the customization of the get behavior |
Returns
Promise<GetArtifactResponse>
Defined in
listArtifacts
▸ listArtifacts(options?): Promise<ListArtifactsResponse>
Lists all artifacts that are part of the current workflow run. This function will return at most 1000 artifacts per workflow run.
If options.findBy is specified, this will call the public List-Artifacts API which can list from other runs.
https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#list-workflow-run-artifacts
Parameters
| Name | Type | Description |
|---|---|---|
options? |
ListArtifactsOptions & FindOptions |
Extra options that allow for the customization of the list behavior |
Returns
Promise<ListArtifactsResponse>
ListArtifactResponse object
Defined in
uploadArtifact
▸ uploadArtifact(name, files, rootDirectory, options?): Promise<UploadArtifactResponse>
Uploads an artifact.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the artifact, required |
files |
string[] |
A list of absolute or relative paths that denote what files should be uploaded |
rootDirectory |
string |
An absolute or relative file path that denotes the root parent directory of the files being uploaded |
options? |
UploadArtifactOptions |
Extra options for customizing the upload behavior |
Returns
Promise<UploadArtifactResponse>
single UploadArtifactResponse object