maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update doc formatting

Browse source
This commit is contained in:
evanboyle 2020-10-07 19:00:03 -07:00 committed by Evan Boyle
parent 73a5516958
commit 97e1d25802
5 changed files with 12 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
sdk/nodejs/tests/testmode.spec.ts
View file

@ -38,7 +38,7 @@ describe("testMode", () => {
// Fetching the stack name while not in test mode errors out.
assert.throws(() => { const _ = runtime.getStack(); }, testModeDisabledError);
});
it("accpets test mode", asyncTest(async () => {
it("accepts test mode", asyncTest(async () => {
// Set up all the test mode envvars, so that the test will pass.
runtime._setTestModeEnabled(true);
const testProject = "TestProject";

2
sdk/nodejs/x/automation/errors.ts
View file

@ -25,7 +25,7 @@ export class CommandError extends Error {
/** @internal */
constructor(private commandResult: CommandResult) {
super(commandResult.toString());
this.name = "PulumiCommandError";
this.name = "CommandError";
}
/**
* Returns true if the error was a result of a conflicting update locking the stack.

22
sdk/nodejs/x/automation/localWorkspace.ts
View file

@ -44,7 +44,7 @@ export class LocalWorkspace implements Workspace {
readonly workDir: string;
/**
* The directory override for CLI metadata if set.
* This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.
* This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.
*/
readonly pulumiHome?: string;
/**
@ -53,15 +53,14 @@ export class LocalWorkspace implements Workspace {
*/
readonly secretsProvider?: string;
/**
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
*/
public program?: PulumiFn;
/**
* Environment values scoped to the current workspace. These will be supplied to every Pulumi command.
*/
public envVars: { [key: string]: string };
/** @internal */
private ready: Promise<any[]>;
/**
* Creates a workspace using the specified options. Used for maximal control and customization
@ -93,7 +92,6 @@ export class LocalWorkspace implements Workspace {
* @param opts Additional customizations to be applied to the Workspace.
*/
public static async createStack(args: InlineProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack>;
/** @internal */
public static async createStack(args: InlineProgramArgs | LocalProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack> {
if (isInlineProgramArgs(args)) {
return await this.inlineSourceStackHelper(args, Stack.create, opts);
@ -121,7 +119,6 @@ export class LocalWorkspace implements Workspace {
* @param opts Additional customizations to be applied to the Workspace.
*/
public static async selectStack(args: InlineProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack>;
/** @internal */
public static async selectStack(args: InlineProgramArgs | LocalProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack> {
if (isInlineProgramArgs(args)) {
return await this.inlineSourceStackHelper(args, Stack.select, opts);
@ -150,7 +147,6 @@ export class LocalWorkspace implements Workspace {
* @param opts Additional customizations to be applied to the Workspace.
*/
public static async createOrSelectStack(args: InlineProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack>;
/** @internal */
public static async createOrSelectStack(args: InlineProgramArgs | LocalProgramArgs, opts?: LocalWorkspaceOptions): Promise<Stack> {
if (isInlineProgramArgs(args)) {
return await this.inlineSourceStackHelper(args, Stack.createOrSelect, opts);
@ -159,7 +155,6 @@ export class LocalWorkspace implements Workspace {
}
throw new Error(`unexpected args: ${args}`);
}
/** @internal */
private static async localSourceStackHelper(
args: LocalProgramArgs, initFn: StackInitializer, opts?: LocalWorkspaceOptions,
): Promise<Stack> {
@ -173,7 +168,6 @@ export class LocalWorkspace implements Workspace {
return await initFn(args.stackName, ws);
}
/** @internal */
private static async inlineSourceStackHelper(
args: InlineProgramArgs, initFn: StackInitializer, opts?: LocalWorkspaceOptions,
): Promise<Stack> {
@ -191,7 +185,6 @@ export class LocalWorkspace implements Workspace {
return await initFn(args.stackName, ws);
}
/** @internal */
private constructor(opts?: LocalWorkspaceOptions) {
let dir = "";
let envs = {};
@ -468,7 +461,7 @@ export class LocalWorkspace implements Workspace {
*/
async serializeArgsForOp(_: string): Promise<string[]> {
// LocalWorkspace does not utilize this extensibility point.
return [];
return [];
}
/**
* postCommandCallback is a hook executed after every command. Called with the stack name.
@ -479,7 +472,6 @@ export class LocalWorkspace implements Workspace {
// LocalWorkspace does not utilize this extensibility point.
return;
}
/** @internal */
private async runPulumiCmd(
args: string[],
): Promise<CommandResult> {
@ -505,7 +497,7 @@ export interface InlineProgramArgs {
*/
projectName: string;
/**
* The inline (in process) Pulumi program to use with Update and Preivew operations.
* The inline (in process) Pulumi program to use with Update and Preview operations.
*/
program: PulumiFn;
}
@ -532,8 +524,8 @@ export interface LocalWorkspaceOptions {
*/
pulumiHome?: string;
/**
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
*/
program?: PulumiFn;
/**

3
sdk/nodejs/x/automation/stack.ts
View file

@ -39,7 +39,6 @@ export class Stack {
* The Workspace the Stack was created from.
*/
readonly workspace: Workspace;
/** @internal */
private ready: Promise<any>;
/**
* Creates a new stack using the given workspace, and stack name.
@ -80,7 +79,6 @@ export class Stack {
await stack.ready;
return stack;
}
/** @internal */
private constructor(name: string, workspace: Workspace, mode: StackInitMode) {
this.name = name;
this.workspace = workspace;
@ -426,7 +424,6 @@ export class Stack {
}
return history[0];
}
/** @internal */
private async runPulumiCmd(args: string[], onOutput?: (out: string) => void): Promise<CommandResult> {
let envs: { [key: string]: string } = {};
const pulumiHome = this.workspace.pulumiHome;

6
sdk/nodejs/x/automation/workspace.ts
View file

@ -30,7 +30,7 @@ export interface Workspace {
readonly workDir: string;
/**
* The directory override for CLI metadata if set.
* This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.
* This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed.
*/
readonly pulumiHome?: string;
/**
@ -39,8 +39,8 @@ export interface Workspace {
*/
readonly secretsProvider?: string;
/**
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
* The inline program `PulumiFn` to be used for Preview/Update operations if any.
* If none is specified, the stack will refer to ProjectSettings for this information.
*/
program?: PulumiFn;
/**