History

Pat Gavlin 73f4f2c464 Reimplement refresh. (#1814 ) Replace the Source-based implementation of refresh with a phase that runs as the first part of plan execution and rewrites the snapshot in-memory. In order to fit neatly within the existing framework for resource operations, these changes introduce a new kind of step, RefreshStep, to represent refreshes. RefreshSteps operate similar to ReadSteps but do not imply that the resource being read is not managed by Pulumi. In addition to the refresh reimplementation, these changes incorporate those from #1394 to run refresh in the integration test framework. Fixes #1598. Fixes pulumi/pulumi-terraform#165. Contributes to #1449.		2018-08-22 17:52:46 -07:00
..
asset	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
cmd	Reimplement refresh. (#1814 )	2018-08-22 17:52:46 -07:00
dist	Don't set NODE_PATH in dynamic provider	2018-06-15 11:12:24 -07:00
dynamic	Reimplement refresh. (#1814 )	2018-08-22 17:52:46 -07:00
log	Add support for providing a log stream-id to our RPC interface. (#1627 )	2018-07-11 15:04:00 -07:00
proto	Implement first-class providers. (#1695 )	2018-08-06 17:50:29 -07:00
runtime	Emit export at the end-of-file for factory functions. (#1812 )	2018-08-22 12:33:01 -07:00
tests	Emit export at the end-of-file for factory functions. (#1812 )	2018-08-22 12:33:01 -07:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Allow eliding name in pulumi.Config .ctor	2018-08-06 16:03:54 -07:00
errors.ts	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
index.ts	Expose the InvokeOptions type in the Node SDK. (#1724 )	2018-08-07 13:14:16 -07:00
invoke.ts	Pull default options from a resource's parent. (#1748 )	2018-08-10 16:18:21 -07:00
Makefile	Added dist target for make, will help with Homebrew (#1731 )	2018-08-08 13:00:42 -07:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
package.json	Support TypeScript in a more first-class way	2018-08-06 14:00:58 -07:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
resource.ts	Pull default options from a resource's parent. (#1748 )	2018-08-10 16:18:21 -07:00
tsconfig.json	Do not lazy initialize config or settings	2018-08-06 15:53:38 -07:00
tslint.json	Add license headers	2018-05-22 15:02:47 -07:00
version.ts	Add license headers	2018-05-22 15:02:47 -07:00
yarn.lock	Support TypeScript in a more first-class way	2018-08-06 14:00:58 -07:00

README.md

Pulumi Node.js SDK

The Pulumi Node.js SDK lets you write cloud programs in JavaScript.

Installation

Using npm:

$ npm install --save @pulumi/pulumi

Using yarn:

$ yarn add @pulumi/pulumi

This SDK is meant for use with the Pulumi CLI. Please visit pulumi.io for installation instructions.

Building and Testing

For anybody who wants to build from source, here is how you do it.

Prerequisites

This SDK uses Node.js and we support the Active LTS and Current releases, as defined by this table. We support both NPM and Yarn for package management.

At the moment, we only support building on macOS and Linux, where standard GNU tools like make are available.

Make Targets

The first time you build, run make ensure to install and prepare native plugins for V8:

$ make ensure

This is only necessary if you intend to produce a build that is capable of running older versions of the SDK contained in this directory. If you do intend to do this, you must have node 6.10.2 installed.

To build the SDK, simply run make from the root directory (where this README lives, at sdk/nodejs/ from the repo's root). This will build the code, run tests, and install the package and its supporting artifacts.

At the moment, for local development, we install everything into /opt/pulumi. You will want this on your $PATH.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi update from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.