7f5e089f04
This update includes several changes to core `@pulumi/pulumi` constructs that will not play nicely in side-by-side applications that pull in prior versions of this package. As such, we are rev'ing the minor version of the package from 0.16 to 0.17. Recent version of `pulumi` will now detect, and warn, if different versions of `@pulumi/pulumi` are loaded into the same application. If you encounter this warning, it is recommended you move to versions of the `@pulumi/...` packages that are compatible. i.e. keep everything on 0.16.x until you are ready to move everything to 0.17.x. ### Improvements - `Output<T>` now 'lifts' property members from the value it wraps, simplifying common coding patterns. Note: this wrapping only happens for POJO values, not `Output<Resource>`s. - Depending on a **Component** Resource will now depend on all other Resources parented by that Resource. This will help out the programming model for Component Resources as your consumers can just depend on a Component and have that automatically depend on all the child Resources created by that Component. Note: this does not apply to a **Custom** resource. Depending on a CustomResource will still only wait on that single resource being created, not any other Resources that consider that CustomResource to be a parent. |
||
---|---|---|
.. | ||
asset | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
proto | ||
runtime | ||
tests | ||
.gitignore | ||
Makefile | ||
README.md | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
output.ts | ||
package.json | ||
resource.ts | ||
stackReference.ts | ||
tsconfig.json | ||
tslint.json | ||
utils.ts | ||
version.ts |
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.