History

CyrusNajmabadi d6d839608b Tweak signature of .apply to help TS infer things better. (#2520 )		2019-03-06 01:53:58 -08:00
..
asset	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08:00
cmd	Do a version check and emit a warning if major/minor versions of @pulumi/pulumi do not match. (#2503 )	2019-03-01 17:43:26 -08:00
dist	Do not use relative path when launching dynamic provider	2018-12-05 13:45:06 -08:00
dynamic	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
iterable	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
log	Have child resources update their parent urn to include themselves in its dependencies. (#2299 )	2019-02-21 20:18:29 -08:00
proto	Update the provider RPC interface (#2512 )	2019-03-05 10:49:24 -08:00
runtime	Update `@pulumi/pulumi` to version 0.17.0 (#2510 )	2019-03-05 17:06:57 -08:00
tests	Update `@pulumi/pulumi` to version 0.17.0 (#2510 )	2019-03-05 17:06:57 -08:00
.gitignore	Continue to add native modules to NODE_PATH	2018-04-13 14:26:32 -07:00
config.ts	Fix requireObject docs (#1961 )	2018-09-21 07:58:14 -07:00
errors.ts	Can't change this name as SxS versions of pulumi may expect the old name. (#2500 )	2019-02-28 16:18:01 -08:00
index.ts	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
invoke.ts	Pull default options from a resource's parent. (#1748 )	2018-08-10 16:18:21 -07:00
Makefile	test_all for the sdk should run test_fast tests. (#2485 )	2019-02-26 14:12:43 -08:00
metadata.ts	Add license headers	2018-05-22 15:02:47 -07:00
output.ts	Tweak signature of .apply to help TS infer things better. (#2520 )	2019-03-06 01:53:58 -08:00
package.json	Bump @types/node dependency	2018-11-13 11:20:21 -08:00
README.md	Remove Private Beta warning	2018-06-18 05:00:38 -07:00
resource.ts	Update `@pulumi/pulumi` to version 0.17.0 (#2510 )	2019-03-05 17:06:57 -08:00
stackReference.ts	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
tsconfig.json	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08:00
tslint.json	Fix issue with comments throwing off function/class serialization (#2438 )	2019-02-08 14:58:24 -08:00
utils.ts	Implement rtti checks more consistently (#2498 )	2019-02-28 14:56:35 -08:00
version.ts	Add license headers	2018-05-22 15:02:47 -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.