From 1bb569c8e13da167139bce982bb86b77c7c93b55 Mon Sep 17 00:00:00 2001 From: Maxim Ivanov Date: Thu, 30 May 2024 12:20:07 -0400 Subject: [PATCH] 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 --- packages/artifact/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/artifact/README.md b/packages/artifact/README.md index 5a98da0e..e800b8de 100644 --- a/packages/artifact/README.md +++ b/packages/artifact/README.md @@ -90,6 +90,8 @@ const {id, size} = await artifact.uploadArtifact( 'my-artifact', // files to include (supports absolute and relative paths) ['/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 // if unspecified, defaults to repository/org retention settings (the limit of this value)