From 58c2878fce24c68ab0f93026b93e2b2f186cd279 Mon Sep 17 00:00:00 2001 From: Rob Herley Date: Thu, 18 Jan 2024 09:51:01 -0500 Subject: [PATCH 1/2] generate docs + update releases --- packages/artifact/RELEASES.md | 4 + packages/artifact/docs/generated/README.md | 5 +- .../classes/ArtifactNotFoundError.md | 2 +- .../classes/DefaultArtifactClient.md | 42 +++- .../generated/classes/FilesNotFoundError.md | 4 +- .../classes/GHESNotSupportedError.md | 2 +- .../generated/classes/InvalidResponseError.md | 2 +- .../docs/generated/classes/NetworkError.md | 201 ++++++++++++++++++ .../docs/generated/classes/UsageError.md | 184 ++++++++++++++++ .../docs/generated/interfaces/Artifact.md | 8 +- .../generated/interfaces/ArtifactClient.md | 38 +++- .../interfaces/DeleteArtifactResponse.md | 23 ++ .../interfaces/DownloadArtifactOptions.md | 2 +- .../interfaces/DownloadArtifactResponse.md | 2 +- .../docs/generated/interfaces/FindOptions.md | 2 +- .../interfaces/GetArtifactResponse.md | 2 +- .../interfaces/ListArtifactsOptions.md | 2 +- .../interfaces/ListArtifactsResponse.md | 2 +- .../interfaces/UploadArtifactOptions.md | 4 +- .../interfaces/UploadArtifactResponse.md | 4 +- packages/artifact/package.json | 4 +- 21 files changed, 507 insertions(+), 32 deletions(-) create mode 100644 packages/artifact/docs/generated/classes/NetworkError.md create mode 100644 packages/artifact/docs/generated/classes/UsageError.md create mode 100644 packages/artifact/docs/generated/interfaces/DeleteArtifactResponse.md diff --git a/packages/artifact/RELEASES.md b/packages/artifact/RELEASES.md index 064a34e6..27cd74a3 100644 --- a/packages/artifact/RELEASES.md +++ b/packages/artifact/RELEASES.md @@ -105,3 +105,7 @@ ### 2.0.1 - Patch to fix transient request timeouts https://github.com/actions/download-artifact/issues/249 + +### 2.1.0 + +- Added `ArtifactClient#deleteArtifact` to delete artifacts by name [#1626](https://github.com/actions/toolkit/pull/1626) diff --git a/packages/artifact/docs/generated/README.md b/packages/artifact/docs/generated/README.md index a1244395..aeeaade2 100644 --- a/packages/artifact/docs/generated/README.md +++ b/packages/artifact/docs/generated/README.md @@ -11,11 +11,14 @@ - [FilesNotFoundError](classes/FilesNotFoundError.md) - [GHESNotSupportedError](classes/GHESNotSupportedError.md) - [InvalidResponseError](classes/InvalidResponseError.md) +- [NetworkError](classes/NetworkError.md) +- [UsageError](classes/UsageError.md) ### Interfaces - [Artifact](interfaces/Artifact.md) - [ArtifactClient](interfaces/ArtifactClient.md) +- [DeleteArtifactResponse](interfaces/DeleteArtifactResponse.md) - [DownloadArtifactOptions](interfaces/DownloadArtifactOptions.md) - [DownloadArtifactResponse](interfaces/DownloadArtifactResponse.md) - [FindOptions](interfaces/FindOptions.md) @@ -37,4 +40,4 @@ #### Defined in -[src/artifact.ts:7](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/artifact.ts#L7) +[src/artifact.ts:7](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/artifact.ts#L7) diff --git a/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md b/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md index 61700bb3..8b39bd0b 100644 --- a/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md +++ b/packages/artifact/docs/generated/classes/ArtifactNotFoundError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:24](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L24) +[src/internal/shared/errors.ts:24](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L24) ## Properties diff --git a/packages/artifact/docs/generated/classes/DefaultArtifactClient.md b/packages/artifact/docs/generated/classes/DefaultArtifactClient.md index b93afc3e..6ac11c31 100644 --- a/packages/artifact/docs/generated/classes/DefaultArtifactClient.md +++ b/packages/artifact/docs/generated/classes/DefaultArtifactClient.md @@ -16,6 +16,7 @@ The default artifact client that is used by the artifact action(s). ### Methods +- [deleteArtifact](DefaultArtifactClient.md#deleteartifact) - [downloadArtifact](DefaultArtifactClient.md#downloadartifact) - [getArtifact](DefaultArtifactClient.md#getartifact) - [listArtifacts](DefaultArtifactClient.md#listartifacts) @@ -33,6 +34,37 @@ The default artifact client that is used by the artifact action(s). ## Methods +### deleteArtifact + +▸ **deleteArtifact**(`artifactName`, `options?`): `Promise`\<[`DeleteArtifactResponse`](../interfaces/DeleteArtifactResponse.md)\> + +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`](../interfaces/FindOptions.md) | Extra options that allow for the customization of the delete behavior | + +#### Returns + +`Promise`\<[`DeleteArtifactResponse`](../interfaces/DeleteArtifactResponse.md)\> + +single DeleteArtifactResponse object + +#### Implementation of + +[ArtifactClient](../interfaces/ArtifactClient.md).[deleteArtifact](../interfaces/ArtifactClient.md#deleteartifact) + +#### Defined in + +[src/internal/client.ts:248](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L248) + +___ + ### downloadArtifact ▸ **downloadArtifact**(`artifactId`, `options?`): `Promise`\<[`DownloadArtifactResponse`](../interfaces/DownloadArtifactResponse.md)\> @@ -45,7 +77,7 @@ If `options.findBy` is specified, this will use the public Download Artifact API | Name | Type | Description | | :------ | :------ | :------ | -| `artifactId` | `number` | The name of the artifact to download | +| `artifactId` | `number` | The id of the artifact to download | | `options?` | [`DownloadArtifactOptions`](../interfaces/DownloadArtifactOptions.md) & [`FindOptions`](../interfaces/FindOptions.md) | Extra options that allow for the customization of the download behavior | #### Returns @@ -60,7 +92,7 @@ single DownloadArtifactResponse object #### Defined in -[src/internal/client.ts:119](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L119) +[src/internal/client.ts:138](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L138) ___ @@ -95,7 +127,7 @@ If there are multiple artifacts with the same name in the same workflow run this #### Defined in -[src/internal/client.ts:193](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L193) +[src/internal/client.ts:212](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L212) ___ @@ -127,7 +159,7 @@ ListArtifactResponse object #### Defined in -[src/internal/client.ts:157](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L157) +[src/internal/client.ts:176](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L176) ___ @@ -158,4 +190,4 @@ single UploadArtifactResponse object #### Defined in -[src/internal/client.ts:94](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L94) +[src/internal/client.ts:113](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L113) diff --git a/packages/artifact/docs/generated/classes/FilesNotFoundError.md b/packages/artifact/docs/generated/classes/FilesNotFoundError.md index c7d22014..f20b608b 100644 --- a/packages/artifact/docs/generated/classes/FilesNotFoundError.md +++ b/packages/artifact/docs/generated/classes/FilesNotFoundError.md @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:4](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L4) +[src/internal/shared/errors.ts:4](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L4) ## Properties @@ -59,7 +59,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:2](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L2) +[src/internal/shared/errors.ts:2](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L2) ___ diff --git a/packages/artifact/docs/generated/classes/GHESNotSupportedError.md b/packages/artifact/docs/generated/classes/GHESNotSupportedError.md index 942ae287..63e89906 100644 --- a/packages/artifact/docs/generated/classes/GHESNotSupportedError.md +++ b/packages/artifact/docs/generated/classes/GHESNotSupportedError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:31](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L31) +[src/internal/shared/errors.ts:31](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L31) ## Properties diff --git a/packages/artifact/docs/generated/classes/InvalidResponseError.md b/packages/artifact/docs/generated/classes/InvalidResponseError.md index 1f6b0b5b..bd1d80cb 100644 --- a/packages/artifact/docs/generated/classes/InvalidResponseError.md +++ b/packages/artifact/docs/generated/classes/InvalidResponseError.md @@ -48,7 +48,7 @@ Error.constructor #### Defined in -[src/internal/shared/errors.ts:17](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/errors.ts#L17) +[src/internal/shared/errors.ts:17](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L17) ## Properties diff --git a/packages/artifact/docs/generated/classes/NetworkError.md b/packages/artifact/docs/generated/classes/NetworkError.md new file mode 100644 index 00000000..1383b639 --- /dev/null +++ b/packages/artifact/docs/generated/classes/NetworkError.md @@ -0,0 +1,201 @@ +[@actions/artifact](../README.md) / NetworkError + +# Class: NetworkError + +## Hierarchy + +- `Error` + + ↳ **`NetworkError`** + +## Table of contents + +### Constructors + +- [constructor](NetworkError.md#constructor) + +### Properties + +- [code](NetworkError.md#code) +- [message](NetworkError.md#message) +- [name](NetworkError.md#name) +- [stack](NetworkError.md#stack) +- [prepareStackTrace](NetworkError.md#preparestacktrace) +- [stackTraceLimit](NetworkError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](NetworkError.md#capturestacktrace) +- [isNetworkErrorCode](NetworkError.md#isnetworkerrorcode) + +## Constructors + +### constructor + +• **new NetworkError**(`code`): [`NetworkError`](NetworkError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | + +#### Returns + +[`NetworkError`](NetworkError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/internal/shared/errors.ts:42](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L42) + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +[src/internal/shared/errors.ts:40](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L40) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 + +___ + +### isNetworkErrorCode + +▸ **isNetworkErrorCode**(`code?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/internal/shared/errors.ts:49](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L49) diff --git a/packages/artifact/docs/generated/classes/UsageError.md b/packages/artifact/docs/generated/classes/UsageError.md new file mode 100644 index 00000000..9d7900fd --- /dev/null +++ b/packages/artifact/docs/generated/classes/UsageError.md @@ -0,0 +1,184 @@ +[@actions/artifact](../README.md) / UsageError + +# Class: UsageError + +## Hierarchy + +- `Error` + + ↳ **`UsageError`** + +## Table of contents + +### Constructors + +- [constructor](UsageError.md#constructor) + +### Properties + +- [message](UsageError.md#message) +- [name](UsageError.md#name) +- [stack](UsageError.md#stack) +- [prepareStackTrace](UsageError.md#preparestacktrace) +- [stackTraceLimit](UsageError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](UsageError.md#capturestacktrace) +- [isUsageErrorMessage](UsageError.md#isusageerrormessage) + +## Constructors + +### constructor + +• **new UsageError**(): [`UsageError`](UsageError.md) + +#### Returns + +[`UsageError`](UsageError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/internal/shared/errors.ts:62](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L62) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 + +___ + +### isUsageErrorMessage + +▸ **isUsageErrorMessage**(`msg?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/internal/shared/errors.ts:68](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/errors.ts#L68) diff --git a/packages/artifact/docs/generated/interfaces/Artifact.md b/packages/artifact/docs/generated/interfaces/Artifact.md index 1597daa5..a4cb4e17 100644 --- a/packages/artifact/docs/generated/interfaces/Artifact.md +++ b/packages/artifact/docs/generated/interfaces/Artifact.md @@ -23,7 +23,7 @@ The time when the artifact was created #### Defined in -[src/internal/shared/interfaces.ts:123](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L123) +[src/internal/shared/interfaces.ts:123](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L123) ___ @@ -35,7 +35,7 @@ The ID of the artifact #### Defined in -[src/internal/shared/interfaces.ts:113](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L113) +[src/internal/shared/interfaces.ts:113](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L113) ___ @@ -47,7 +47,7 @@ The name of the artifact #### Defined in -[src/internal/shared/interfaces.ts:108](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L108) +[src/internal/shared/interfaces.ts:108](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L108) ___ @@ -59,4 +59,4 @@ The size of the artifact in bytes #### Defined in -[src/internal/shared/interfaces.ts:118](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L118) +[src/internal/shared/interfaces.ts:118](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L118) diff --git a/packages/artifact/docs/generated/interfaces/ArtifactClient.md b/packages/artifact/docs/generated/interfaces/ArtifactClient.md index 39f7d923..cf97ff33 100644 --- a/packages/artifact/docs/generated/interfaces/ArtifactClient.md +++ b/packages/artifact/docs/generated/interfaces/ArtifactClient.md @@ -12,6 +12,7 @@ Generic interface for the artifact client. ### Methods +- [deleteArtifact](ArtifactClient.md#deleteartifact) - [downloadArtifact](ArtifactClient.md#downloadartifact) - [getArtifact](ArtifactClient.md#getartifact) - [listArtifacts](ArtifactClient.md#listartifacts) @@ -19,6 +20,33 @@ Generic interface for the artifact client. ## Methods +### deleteArtifact + +▸ **deleteArtifact**(`artifactName`, `options?`): `Promise`\<[`DeleteArtifactResponse`](DeleteArtifactResponse.md)\> + +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`](FindOptions.md) | Extra options that allow for the customization of the delete behavior | + +#### Returns + +`Promise`\<[`DeleteArtifactResponse`](DeleteArtifactResponse.md)\> + +single DeleteArtifactResponse object + +#### Defined in + +[src/internal/client.ts:103](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L103) + +___ + ### downloadArtifact ▸ **downloadArtifact**(`artifactId`, `options?`): `Promise`\<[`DownloadArtifactResponse`](DownloadArtifactResponse.md)\> @@ -31,7 +59,7 @@ If `options.findBy` is specified, this will use the public Download Artifact API | Name | Type | Description | | :------ | :------ | :------ | -| `artifactId` | `number` | The name of the artifact to download | +| `artifactId` | `number` | The id of the artifact to download | | `options?` | [`DownloadArtifactOptions`](DownloadArtifactOptions.md) & [`FindOptions`](FindOptions.md) | Extra options that allow for the customization of the download behavior | #### Returns @@ -42,7 +70,7 @@ single DownloadArtifactResponse object #### Defined in -[src/internal/client.ts:84](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L84) +[src/internal/client.ts:89](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L89) ___ @@ -73,7 +101,7 @@ If there are multiple artifacts with the same name in the same workflow run this #### Defined in -[src/internal/client.ts:70](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L70) +[src/internal/client.ts:75](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L75) ___ @@ -101,7 +129,7 @@ ListArtifactResponse object #### Defined in -[src/internal/client.ts:52](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L52) +[src/internal/client.ts:57](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L57) ___ @@ -128,4 +156,4 @@ single UploadArtifactResponse object #### Defined in -[src/internal/client.ts:35](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/client.ts#L35) +[src/internal/client.ts:40](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/client.ts#L40) diff --git a/packages/artifact/docs/generated/interfaces/DeleteArtifactResponse.md b/packages/artifact/docs/generated/interfaces/DeleteArtifactResponse.md new file mode 100644 index 00000000..209b2095 --- /dev/null +++ b/packages/artifact/docs/generated/interfaces/DeleteArtifactResponse.md @@ -0,0 +1,23 @@ +[@actions/artifact](../README.md) / DeleteArtifactResponse + +# Interface: DeleteArtifactResponse + +Response from the server when deleting an artifact + +## Table of contents + +### Properties + +- [id](DeleteArtifactResponse.md#id) + +## Properties + +### id + +• **id**: `number` + +The id of the artifact that was deleted + +#### Defined in + +[src/internal/shared/interfaces.ts:158](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L158) diff --git a/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md b/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md index 8eff4d8f..1b34e637 100644 --- a/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md +++ b/packages/artifact/docs/generated/interfaces/DownloadArtifactOptions.md @@ -20,4 +20,4 @@ Denotes where the artifact will be downloaded to. If not specified then the arti #### Defined in -[src/internal/shared/interfaces.ts:98](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L98) +[src/internal/shared/interfaces.ts:98](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L98) diff --git a/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md b/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md index b2220364..dd3e80bf 100644 --- a/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/DownloadArtifactResponse.md @@ -20,4 +20,4 @@ The path where the artifact was downloaded to #### Defined in -[src/internal/shared/interfaces.ts:88](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L88) +[src/internal/shared/interfaces.ts:88](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L88) diff --git a/packages/artifact/docs/generated/interfaces/FindOptions.md b/packages/artifact/docs/generated/interfaces/FindOptions.md index 68f56706..32e0f5b7 100644 --- a/packages/artifact/docs/generated/interfaces/FindOptions.md +++ b/packages/artifact/docs/generated/interfaces/FindOptions.md @@ -27,4 +27,4 @@ The criteria for finding Artifact(s) out of the scope of the current run. #### Defined in -[src/internal/shared/interfaces.ts:131](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L131) +[src/internal/shared/interfaces.ts:131](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L131) diff --git a/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md b/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md index f4d56509..8f4405ae 100644 --- a/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/GetArtifactResponse.md @@ -20,4 +20,4 @@ Metadata about the artifact that was found #### Defined in -[src/internal/shared/interfaces.ts:57](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L57) +[src/internal/shared/interfaces.ts:57](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L57) diff --git a/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md b/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md index 27e3d5f7..c6a65432 100644 --- a/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md +++ b/packages/artifact/docs/generated/interfaces/ListArtifactsOptions.md @@ -21,4 +21,4 @@ In the case of reruns, this can be useful to avoid duplicates #### Defined in -[src/internal/shared/interfaces.ts:68](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L68) +[src/internal/shared/interfaces.ts:68](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L68) diff --git a/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md b/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md index 836cbbd7..3b1ebe8e 100644 --- a/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md +++ b/packages/artifact/docs/generated/interfaces/ListArtifactsResponse.md @@ -20,4 +20,4 @@ A list of artifacts that were found #### Defined in -[src/internal/shared/interfaces.ts:78](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L78) +[src/internal/shared/interfaces.ts:78](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L78) diff --git a/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md b/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md index acff13df..d2c07a0c 100644 --- a/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md +++ b/packages/artifact/docs/generated/interfaces/UploadArtifactOptions.md @@ -28,7 +28,7 @@ For large files that are not easily compressed, a value of 0 is recommended for #### Defined in -[src/internal/shared/interfaces.ts:47](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L47) +[src/internal/shared/interfaces.ts:47](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L47) ___ @@ -52,4 +52,4 @@ input of 0 assumes default retention setting. #### Defined in -[src/internal/shared/interfaces.ts:36](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L36) +[src/internal/shared/interfaces.ts:36](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L36) diff --git a/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md b/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md index 574366fc..ea98efb0 100644 --- a/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md +++ b/packages/artifact/docs/generated/interfaces/UploadArtifactResponse.md @@ -22,7 +22,7 @@ This ID can be used as input to other APIs to download, delete or get more infor #### Defined in -[src/internal/shared/interfaces.ts:14](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L14) +[src/internal/shared/interfaces.ts:14](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L14) ___ @@ -34,4 +34,4 @@ Total size of the artifact in bytes. Not provided if no artifact was uploaded #### Defined in -[src/internal/shared/interfaces.ts:8](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L8) +[src/internal/shared/interfaces.ts:8](https://github.com/actions/toolkit/blob/daf23ba/packages/artifact/src/internal/shared/interfaces.ts#L8) diff --git a/packages/artifact/package.json b/packages/artifact/package.json index 3dfa461a..b25a30af 100644 --- a/packages/artifact/package.json +++ b/packages/artifact/package.json @@ -1,6 +1,6 @@ { "name": "@actions/artifact", - "version": "2.0.1", + "version": "2.1.0", "preview": true, "description": "Actions artifact lib", "keywords": [ @@ -62,4 +62,4 @@ "typedoc-plugin-markdown": "^3.17.1", "typescript": "^5.2.2" } -} \ No newline at end of file +} From 017d757dd40c2deadf4b19f3bf44951001f21e94 Mon Sep 17 00:00:00 2001 From: Rob Herley Date: Thu, 18 Jan 2024 11:07:25 -0500 Subject: [PATCH 2/2] update releases.md --- packages/artifact/RELEASES.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/artifact/RELEASES.md b/packages/artifact/RELEASES.md index 27cd74a3..e4bc0c1f 100644 --- a/packages/artifact/RELEASES.md +++ b/packages/artifact/RELEASES.md @@ -109,3 +109,4 @@ ### 2.1.0 - Added `ArtifactClient#deleteArtifact` to delete artifacts by name [#1626](https://github.com/actions/toolkit/pull/1626) +- Update error messaging to be more useful [#1628](https://github.com/actions/toolkit/pull/1628)