UNPKG

1.31 kBTypeScriptView Raw
1import { FulfillableGoalDetails, FulfillableGoalWithRegistrations, Goal, ImplementationRegistration } from "@atomist/sdm";
2/**
3 * Options for Docker deployment goal
4 */
5export interface DockerDeployRegistration extends Partial<ImplementationRegistration> {
6 /**
7 * Starting port to be scanned for free ports. Defaults to 9090
8 */
9 lowerPort?: number;
10 /**
11 * Pattern that indicates that the container has started up correctly
12 */
13 successPatterns: RegExp[];
14 /**
15 * Base URL for the docker container. Probably localhost or your Docker machine IP. Defaults to localhost
16 */
17 baseUrl?: string;
18 /**
19 * The exposed port in the Dockerfile to be mapped externally
20 */
21 sourcePort: number;
22}
23/**
24 * Goal definition for deployment using Docker
25 */
26export declare const DockerDeployGoal: Goal;
27/**
28 * This goal will deploy the Docker image built by the `DockerBuild` goal. Deployments mapped
29 * to free ports and a deployment will be done per branch.
30 */
31export declare class DockerDeploy extends FulfillableGoalWithRegistrations<DockerDeployRegistration> {
32 private readonly goalDetailsOrUniqueName;
33 constructor(goalDetailsOrUniqueName?: FulfillableGoalDetails | string, ...dependsOn: Goal[]);
34 with(registration: DockerDeployRegistration): this;
35}