mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Matt Ellis 7dfc3b630e Remove the need for /opt/pulumi 
This is an artifact of the past, where we did not ship packages via
NPM but instead linked everything. At that time, we wanted to have our
own install location for Pulumi, because it reflected how we shipped
the product.

This was pretty confusing, because we had both `build` and `install`
targets, and we'd put some binaries both in `GOBIN` and
`/opt/pulumi/bin` leading to general confusion.

Now we simplify things. We install everything into GOBIN (both our go
binaries and the language executor scripts) and when we `yarn link` to
register packages we just link the version we built into the bin
folder.

Overall, this should simplify our story and make things a little more
regular.

We no longer require any directories to be created before building
Pulumi.
 		2018-08-29 11:26:12 -07:00
..
asset Make RTTI markers internal (#1479) 2018-06-07 21:34:06 -07:00
cmd Fix an issue with NodeJS host logging (#1819) 2018-08-24 16:50:09 -07:00
dist Don't set NODE_PATH in dynamic provider 2018-06-15 11:12:24 -07:00
dynamic Reimplement refresh. (#1814) 2018-08-22 17:52:46 -07:00
log Add support for providing a log stream-id to our RPC interface. (#1627) 2018-07-11 15:04:00 -07:00
proto Implement first-class providers. (#1695) 2018-08-06 17:50:29 -07:00
runtime Emit export at the end-of-file for factory functions. (#1812) 2018-08-22 12:33:01 -07:00
tests Add test to demonstrate issue is fixed. (#1829) 2018-08-27 14:25:37 -07:00
.gitignore Continue to add native modules to NODE_PATH 2018-04-13 14:26:32 -07:00
Makefile Remove the need for /opt/pulumi 2018-08-29 11:26:12 -07:00
README.md Remove the need for /opt/pulumi 2018-08-29 11:26:12 -07:00
config.ts Allow eliding name in pulumi.Config .ctor 2018-08-06 16:03:54 -07:00
errors.ts Make RTTI markers internal (#1479) 2018-06-07 21:34:06 -07:00
index.ts Expose the InvokeOptions type in the Node SDK. (#1724) 2018-08-07 13:14:16 -07:00
invoke.ts Pull default options from a resource's parent. (#1748) 2018-08-10 16:18:21 -07:00
metadata.ts Add license headers 2018-05-22 15:02:47 -07:00
package.json Support TypeScript in a more first-class way 2018-08-06 14:00:58 -07:00
resource.ts Pull default options from a resource's parent. (#1748) 2018-08-10 16:18:21 -07:00
tsconfig.json Do not lazy initialize config or settings 2018-08-06 15:53:38 -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 Support TypeScript in a more first-class way 2018-08-06 14:00:58 -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

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 the go binary location (which defaults to ~/go/bin). 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.