actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Update artifact readme with required rootDirectory for uploadArtifact 

Just updating the readme with a required argument as per the documented interface: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/generated/interfaces/ArtifactClient.md#uploadartifact
pull/1742/head
Maxim Ivanov 2024-05-30 12:20:07 -04:00 committed by GitHub
parent d1df13e178
commit 1bb569c8e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/artifact/README.md
View File

@ -90,6 +90,8 @@ const {id, size} = await artifact.uploadArtifact(
'my-artifact', 'my-artifact',
// files to include (supports absolute and relative paths) // files to include (supports absolute and relative paths)
['/absolute/path/file1.txt', './relative/file2.txt'], ['/absolute/path/file1.txt', './relative/file2.txt'],
// An absolute or relative file path that denotes the root parent directory of the files being uploaded
'/',
{ {
// optional: how long to retain the artifact // optional: how long to retain the artifact
// if unspecified, defaults to repository/org retention settings (the limit of this value) // if unspecified, defaults to repository/org retention settings (the limit of this value)