@jameslnewell/buildkite-pipelines
Version:
Generate Buildkite pipelines from code.
135 lines (134 loc) • 4.2 kB
TypeScript
import { PluginSchema } from '../../schema';
import { PluginBuilder } from '../PluginBuilder';
/**
* @see https://github.com/buildkite-plugins/docker-buildkite-plugin
*/
export declare class DockerPlugin implements PluginBuilder {
#private;
static PLUGIN: string;
getImage(): string | undefined;
/**
* @deprecated Use .setImage() instead
*/
image(image: string): this;
setImage(image: string): this;
getAlwaysPull(): boolean | undefined;
/**
* @deprecated Use .setAlwaysPull() instead
*/
alwaysPull(alwaysPull?: boolean): this;
setAlwaysPull(alwaysPull: boolean): this;
getCommands(): ReadonlyArray<string>;
/**
* @deprecated Use .addCommand() instead
*/
command(command: string): this;
addCommand(command: string): this;
getDebug(): boolean | undefined;
/**
* @deprecated Use .setDebug() instead
*/
debug(debug?: boolean): this;
setDebug(debug: boolean): this;
getEntrypoint(): string | undefined;
/**
* @deprecated Use .addCommand() instead
*/
entrypoint(entrypoint: string): this;
setEntrypoint(entrypoint: string): this;
getEnvironment(): ReadonlyArray<string>;
/**
* @deprecated Use .addEnvironment() instead
*/
environment(environment: string): this;
addEnvironment(environment: string): this;
getPropagateEnvironment(): boolean | undefined;
/**
* @deprecated Use .setPropagateEnvironment() instead
*/
propagateEnvironment(propagate?: boolean): this;
setPropagateEnvironment(propagate: boolean): this;
getPropagateAWSAauthTokens(): boolean | undefined;
/**
* @deprecated Use .setPropagateAWSAuthTokens() instead
*/
propagateAWSAuthTokens(propagate?: boolean): this;
/**
* @deprecated Use .setPropagateAWSAuthTokens() instead
*/
setPropagateAWSAauthTokens(propagate: boolean): this;
setPropagateAWSAuthTokens(propagate: boolean): this;
getMountCheckout(): boolean | undefined;
/**
* @deprecated Use .setMountCheckout() instead
*/
mountCheckout(mount?: boolean): this;
setMountCheckout(mount?: boolean): this;
getMountBuildkiteAgent(): boolean | undefined;
/**
* @deprecated Use .setMountBuildkiteAgent() instead
*/
mountBuildkiteAgent(mount?: boolean): this;
setMountBuildkiteAgent(mount: boolean): this;
getMountSSHAgent(): boolean | undefined;
/**
* @deprecated Use .setMountSSHAgent() instead
*/
mountSSHAgent(mount?: boolean): this;
setMountSSHAgent(mount: boolean): this;
getPlatform(): string | undefined;
/**
* @deprecated Use .setPlatform() instead
*/
platform(platform: string): this;
setPlatform(platform: string): this;
getShell(): string[] | undefined;
/**
* @deprecated Use .setPlatform() instead
*/
shell(cmd: string, args?: string[]): this;
setShell(cmd: string, args?: string[]): this;
/**
* @deprecated Use .setUser() instead
*/
user(user: string): this;
setUser(user: string): this;
/**
* @deprecated Use .setUserNamespace() instead
*/
userns(namespace: string): this;
setUserns(namespace: string): this;
getVolumes(): ReadonlyArray<string>;
/**
* @deprecated Use .addVolume() instead
*/
volume(volume: string): this;
addVolume(volume: string): this;
/**
* @deprecated Use .setWorkdir() instead
*/
workdir(workdir: string): this;
setWorkdir(workdir: string): this;
/**
* @deprecated Use .setCPUs() instead
*/
cpus(cpus: string): this;
setCPUs(cpus: string): this;
/**
* @deprecated Use .setMemory() instead
*/
memory(memory: string): this;
setMemory(memory: string): this;
/**
* @deprecated Use .setMemorySwap() instead
*/
memorySwap(swap: string): this;
setMemorySwap(swap: string): this;
/**
* @deprecated Use .setMemorySwapiness() instead
*/
memorySwapiness(swappiness: string): this;
setMemorySwapiness(swappiness: string): this;
setExpandVolumeVars(expand: boolean): this;
build(): PluginSchema | Promise<PluginSchema>;
}