actions/toolkit
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/actions/toolkit synced 2026-04-01 14:23:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Generate Typescript Docs for @actions/artifact (#1595)

Browse Source 
* autogenerate artifact documentation

* clean up comments for better autogen docs
This commit is contained in:
Rob Herley
2023-12-07 12:57:20 -05:00
committed by GitHub
parent 43ccaf05d9
commit 64d1b104d0
19 changed files with 1530 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
packages/artifact/src/internal/shared/interfaces.ts
View File

@@ -1,8 +1,6 @@
/*****************************************************************************
* *
* UploadArtifact *
* *
*****************************************************************************/
/**
* Response from the server when an artifact is uploaded
*/
export interface UploadArtifactResponse {
/**
* Total size of the artifact in bytes. Not provided if no artifact was uploaded
@@ -16,6 +14,9 @@ export interface UploadArtifactResponse {
id?: number
}
/**
* Options for uploading an artifact
*/
export interface UploadArtifactOptions {
/**
* Duration after which artifact will expire in days.
@@ -46,12 +47,9 @@ export interface UploadArtifactOptions {
compressionLevel?: number
}
/*****************************************************************************
* *
* GetArtifact *
* *
*****************************************************************************/
/**
* Response from the server when getting an artifact
*/
export interface GetArtifactResponse {
/**
* Metadata about the artifact that was found
@@ -59,12 +57,9 @@ export interface GetArtifactResponse {
artifact: Artifact
}
/*****************************************************************************
* *
* ListArtifact *
* *
*****************************************************************************/
/**
* Options for listing artifacts
*/
export interface ListArtifactsOptions {
/**
* Filter the workflow run's artifacts to the latest by name
@@ -73,6 +68,9 @@ export interface ListArtifactsOptions {
latest?: boolean
}
/**
* Response from the server when listing artifacts
*/
export interface ListArtifactsResponse {
/**
* A list of artifacts that were found
@@ -80,11 +78,9 @@ export interface ListArtifactsResponse {
artifacts: Artifact[]
}
/*****************************************************************************
* *
* DownloadArtifact *
* *
*****************************************************************************/
/**
* Response from the server when downloading an artifact
*/
export interface DownloadArtifactResponse {
/**
* The path where the artifact was downloaded to
@@ -92,6 +88,9 @@ export interface DownloadArtifactResponse {
downloadPath?: string
}
/**
* Options for downloading an artifact
*/
export interface DownloadArtifactOptions {
/**
* Denotes where the artifact will be downloaded to. If not specified then the artifact is download to GITHUB_WORKSPACE
@@ -99,11 +98,9 @@ export interface DownloadArtifactOptions {
path?: string
}
/*****************************************************************************
* *
* Shared *
* *
*****************************************************************************/
/**
* An Actions Artifact
*/
export interface Artifact {
/**
* The name of the artifact
@@ -127,16 +124,26 @@ export interface Artifact {
}
// FindOptions are for fetching Artifact(s) out of the scope of the current run.
// Must specify a token with actions:read scope for cross run/repo lookup otherwise these will be ignored.
export interface FindOptions {
/**
* The criteria for finding Artifact(s) out of the scope of the current run.
*/
findBy?: {
// Token with actions:read permissions
/**
* Token with actions:read permissions
*/
token: string
// WorkflowRun of the artifact(s) to lookup
/**
* WorkflowRun of the artifact(s) to lookup
*/
workflowRunId: number
// Repository owner
/**
* Repository owner (eg. 'actions')
*/
repositoryOwner: string
// Repository name
/**
* Repository owner (eg. 'toolkit')
*/
repositoryName: string
}
}