diff --git a/packages/artifact/RELEASES.md b/packages/artifact/RELEASES.md index e2904cd8..9b368e35 100644 --- a/packages/artifact/RELEASES.md +++ b/packages/artifact/RELEASES.md @@ -2,7 +2,7 @@ ## 6.2.0 -- Support uploading single un-archived files (not zipped). Direct uploads are only supported for artifacts version 7+ (based on the major version of `actions/upload-artifact`). Callers must pass the `skipArchive` option to `uploadArtifact`. Only single files can be uploaded at a time right now. Default behavior should remain unchanged if `skipArchive = false`. +- Support uploading single un-archived files (not zipped). Direct uploads are only supported for artifacts version 7+ (based on the major version of `actions/upload-artifact`). Callers must pass the `skipArchive` option to `uploadArtifact`. Only single files can be uploaded at a time right now. Default behavior should remain unchanged if `skipArchive = false`. When `skipArchive = true`, the name of the file is used as the name of the artifact for consistency with the downloads: you upload `artifact.txt`, you download `artifact.txt`. ## 6.1.0 diff --git a/packages/artifact/src/internal/shared/interfaces.ts b/packages/artifact/src/internal/shared/interfaces.ts index f5a13f03..4ca5b262 100644 --- a/packages/artifact/src/internal/shared/interfaces.ts +++ b/packages/artifact/src/internal/shared/interfaces.ts @@ -54,6 +54,7 @@ export interface UploadArtifactOptions { * If true, the artifact will be uploaded without being archived (zipped). * This is only supported when uploading a single file. * When using this option, the artifact will not be compressed. + * When using this option, the name parameter passed to the upload is ignored. Instead, the name of the file is used as the name of the artifact. */ skipArchive?: boolean }