History

Sean Gillespie 559e1625df Combine two gRPC servers into one for testing (#1918 ) * Combine two gRPC servers into one for testing For some reason, our current gRPC test setup has become flaky now that we are spinning up two gRPC servers. Hopefully merging them into one helps clarify what's going on. * Add back error logging for CI		2018-09-11 15:45:15 -07:00
..
asset	Make RTTI markers internal (#1479 )	2018-06-07 21:34:06 -07:00
cmd	Validate type tokens before using them (#1904 )	2018-09-07 15:19:18 -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	LogRequest.isStatus -> LogRequest.ephemeral	2018-08-31 15:56:53 -07:00
runtime	Validate type tokens before using them (#1904 )	2018-09-07 15:19:18 -07:00
tests	Combine two gRPC servers into one for testing (#1918 )	2018-09-11 15:45:15 -07:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
Makefile	Added dist target for make, will help with Homebrew (#1731 )	2018-08-08 13:00:42 -07:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
config.ts	Fix a comment mistake	2018-08-29 11:29:18 -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
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
package.json	Be resilient to encountering invalid data in a package.json file. (#1897 )	2018-09-06 16:35:14 -07:00
resource.ts	Make `opts.providers` robust to SxS scenarios. (#1901 )	2018-09-07 09:42:19 -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	Be resilient to encountering invalid data in a package.json file. (#1897 )	2018-09-06 16:35:14 -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.