History

Matt Ellis 75744f1d6c Add some convience methods to `pulumi.Config` for getting secrets		2019-05-10 17:07:52 -07:00
..
asset	Properly mark members as @internal (#2670 )	2019-04-23 19:24:06 -07:00
cmd	Do not support secrets natively in the dynamic provider	2019-05-10 17:07:52 -07: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	Remove `acceptsSecrets` from InvokeRequest	2019-05-10 17:07:52 -07:00
runtime	Push secretness "up" while deserializing objects.	2019-05-10 17:07:52 -07:00
tests	Support Secret Outputs in the Node SDK	2019-05-10 17:07:52 -07:00
.gitignore	Add a SxS test for `@pulumi/pulumi` to help catch when we make breaking changes to core types. (#2610 )	2019-03-29 12:27:42 -07:00
config.ts	Add some convience methods to `pulumi.Config` for getting secrets	2019-05-10 17:07:52 -07:00
errors.ts	Properly mark members as @internal (#2670 )	2019-04-23 19:24:06 -07:00
index.ts	Properly mark members as @internal (#2670 )	2019-04-23 19:24:06 -07:00
invoke.ts	Plumb provider version through language hosts to engine (#2656 )	2019-04-23 11:02:51 -07:00
Makefile	Add a SxS test for `@pulumi/pulumi` to help catch when we make breaking changes to core types. (#2610 )	2019-03-29 12:27:42 -07:00
metadata.ts	Enable unit testing for Pulumi programs (#2638 )	2019-04-16 22:20:01 -07:00
output.ts	Flush out comment on isSecret promise	2019-05-10 17:07:52 -07:00
package.json	Bump gRPC dependency to 1.20.2	2019-05-01 10:04:27 -07:00
README.md	`pulumi update` => `pulumi up` (#2702 )	2019-05-06 14:00:18 -07:00
resource.ts	Expose `additionalSecretOutputs` in the NodeJS SDK	2019-05-10 17:07:52 -07:00
stackReference.ts	Break out Resource and Output into their own files (#2420 )	2019-01-31 18:08:17 -08:00
tsconfig.json	Enable unit testing for Pulumi programs (#2638 )	2019-04-16 22:20:01 -07: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 up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.