maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Chris Smith 208dfc29b4
Update references to pulumi.io (#2979) 
* Remove pulumi.io reference in tests

* Remove pulumi.io references in Dockerfiles

* Remove pulumi.io references in CONTRIBUTING.md

* Update README.md's

* Use correct logo
2019-07-25 09:58:12 -07:00
..
asset Properly mark members as @internal (#2670) 2019-04-23 19:24:06 -07:00
cmd Remove unnecessary exports (#2956) 2019-07-19 12:49:48 -07:00
dist Add pulumi-analyzer-package scripts in publishing pipeline 2019-07-16 00:58:33 -07: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 Add GetAnalyzerInfo to Analyzer gRPC definition 2019-07-16 00:58:33 -07:00
queryable Implement Omit like TypeScript upstream does 2019-07-19 11:14:31 -07:00
runtime Handle mixed versions of Resources in parent hierarchy (#2942) 2019-07-16 11:15:26 -07:00
tests Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -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 Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -07:00
invoke.ts Add an option to allow callers to specify they would like make invoke calls asynchronously. (#2947) 2019-07-18 17:19:41 -07:00
Makefile Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -07:00
metadata.ts Enable unit testing for Pulumi programs (#2638) 2019-04-16 22:20:01 -07:00
output.ts Revert "Simplify signature of pulumi.all (#2527)" (#2775) 2019-05-28 10:54:56 -07:00
package.json Lock to an earlier version of gRPC 2019-07-09 14:39:53 -07:00
README.md Update references to pulumi.io (#2979) 2019-07-25 09:58:12 -07:00
resource.ts Handle mixed versions of Resources in parent hierarchy (#2942) 2019-07-16 11:15:26 -07:00
stackReference.ts Make it possible to get a StackReference output promptly (#2824) 2019-06-17 12:25:56 -07:00
tsconfig.json Add a helper function to easily convert async functions to sync functions (#2943) 2019-07-16 12:12:21 -07:00
tslint.json Fix issue with comments throwing off function/class serialization (#2438) 2019-02-08 14:58:24 -08:00
utils.ts Add an option to allow callers to specify they would like make invoke calls asynchronously. (#2947) 2019-07-18 17:19:41 -07: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.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 up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.