[Artifacts] Prepare for v2.0.0 of @actions/artifact (#1479)

* Prepare for v2.0.0 of @actions/artifact

* Run prettier

* temporary disable unused vars
This commit is contained in:
Konrad Pabjan
2023-08-03 13:34:41 -04:00
committed by GitHub
parent 91d3933eb5
commit c4f5ce2665
44 changed files with 132 additions and 5896 deletions
@@ -0,0 +1,18 @@
import {UploadOptions} from './upload-options'
import {UploadResponse} from './upload-response'
export async function uploadArtifact(
name: string,
files: string[], // eslint-disable-line @typescript-eslint/no-unused-vars
rootDirectory: string, // eslint-disable-line @typescript-eslint/no-unused-vars
options?: UploadOptions | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
): Promise<UploadResponse> {
// TODO - Implement upload functionality
const uploadResponse: UploadResponse = {
artifactName: name,
size: 0
}
return uploadResponse
}
@@ -0,0 +1,18 @@
export interface UploadOptions {
/**
* Duration after which artifact will expire in days.
*
* By default artifact expires after 90 days:
* https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts#downloading-and-deleting-artifacts-after-a-workflow-run-is-complete
*
* Use this option to override the default expiry.
*
* Min value: 1
* Max value: 90 unless changed by repository setting
*
* If this is set to a greater value than the retention settings allowed, the retention on artifacts
* will be reduced to match the max value allowed on server, and the upload process will continue. An
* input of 0 assumes default retention setting.
*/
retentionDays?: number
}
@@ -0,0 +1,11 @@
export interface UploadResponse {
/**
* The name of the artifact that was uploaded
*/
artifactName: string
/**
* Total size of the artifact that was uploaded in bytes
*/
size: number
}