mirror of
https://github.com/github/codeql-action.git
synced 2025-12-30 19:20:08 +08:00
eba983fb9b
For more information see https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ This change bumps a bunch of the internal actions packages. Note that the only required version change is `actions/core` to 1.10.0. The others are not required, but seem like a reasonable idea. It also changes all of the workflows that use `set-output`.
40 lines
1.9 KiB
TypeScript
40 lines
1.9 KiB
TypeScript
/// <reference types="node" />
|
|
import * as fs from 'fs';
|
|
import { ListArtifactsResponse, QueryArtifactResponse } from './contracts';
|
|
import { HttpClientResponse } from '@actions/http-client';
|
|
import { DownloadItem } from './download-specification';
|
|
export declare class DownloadHttpClient {
|
|
private downloadHttpManager;
|
|
private statusReporter;
|
|
constructor();
|
|
/**
|
|
* Gets a list of all artifacts that are in a specific container
|
|
*/
|
|
listArtifacts(): Promise<ListArtifactsResponse>;
|
|
/**
|
|
* Fetches a set of container items that describe the contents of an artifact
|
|
* @param artifactName the name of the artifact
|
|
* @param containerUrl the artifact container URL for the run
|
|
*/
|
|
getContainerItems(artifactName: string, containerUrl: string): Promise<QueryArtifactResponse>;
|
|
/**
|
|
* Concurrently downloads all the files that are part of an artifact
|
|
* @param downloadItems information about what items to download and where to save them
|
|
*/
|
|
downloadSingleArtifact(downloadItems: DownloadItem[]): Promise<void>;
|
|
/**
|
|
* Downloads an individual file
|
|
* @param httpClientIndex the index of the http client that is used to make all of the calls
|
|
* @param artifactLocation origin location where a file will be downloaded from
|
|
* @param downloadPath destination location for the file being downloaded
|
|
*/
|
|
private downloadIndividualFile;
|
|
/**
|
|
* Pipes the response from downloading an individual file to the appropriate destination stream while decoding gzip content if necessary
|
|
* @param response the http response received when downloading a file
|
|
* @param destinationStream the stream where the file should be written to
|
|
* @param isGzip a boolean denoting if the content is compressed using gzip and if we need to decode it
|
|
*/
|
|
pipeResponseToFile(response: HttpClientResponse, destinationStream: fs.WriteStream, isGzip: boolean): Promise<void>;
|
|
}
|