maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Matt Ellis 9b24ad9738 Update gRPC to 1.12.2 
This version has an updated protobufs dependency, which will remove
the warnings from `npm audit`.

Fixes #1350
2018-05-30 15:42:10 -07:00
..
asset Add license headers 2018-05-22 15:02:47 -07:00
cmd Delete Before Create (#1365) 2018-05-23 14:43:17 -07:00
dist Invoke node directly from the language host 2018-05-02 11:16:58 -07:00
dynamic Add license headers 2018-05-22 15:02:47 -07:00
log Add license headers 2018-05-22 15:02:47 -07:00
proto Add an ID property to ReadResponse (#1145) 2018-04-10 12:58:50 -07:00
runtime Issue a better error message if you capture a V8 intrinsic (#1423) 2018-05-24 11:54:31 -07:00
tests Issue a better error message if you capture a V8 intrinsic (#1423) 2018-05-24 11:54:31 -07:00
.gitignore Continue to add native modules to NODE_PATH 2018-04-13 14:26:32 -07:00
config.ts Add license headers 2018-05-22 15:02:47 -07:00
errors.ts Add license headers 2018-05-22 15:02:47 -07:00
index.ts Add license headers 2018-05-22 15:02:47 -07:00
Makefile Support async function serialization. (#1311) 2018-05-03 12:25:52 -07:00
metadata.ts Add license headers 2018-05-22 15:02:47 -07:00
package.json Update gRPC to 1.12.2 2018-05-30 15:42:10 -07:00
README.md Fix pulumi.com hyperlink in README 2018-05-18 11:22:42 -07:00
resource.ts Discriminate unknown values in the JS runtime. (#1414) 2018-05-23 14:47:40 -07:00
tsconfig.json Support async function serialization. (#1311) 2018-05-03 12:25:52 -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 Update gRPC to 1.12.2 2018-05-30 15:42:10 -07:00

README.md

Pulumi Node.js SDK

⚠️ Pulumi is in private beta. This package may not work unless you are already participating. Please visit pulumi.com to register for access.

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 docs.pulumi.com 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.