e1c1b5e3f4
Tentative changelog: ### Features - [auto/go] Add options to automation API Workspace.Install [#16888](https://github.com/pulumi/pulumi/pull/16888) - [auto/go] Add Remote Automation API support for choosing a deployment runner pool. [#16991](https://github.com/pulumi/pulumi/pull/16991) - [backend/service] Prefer PULUMI_ACCESS_TOKEN set in the environment over the one stored in the config when they don't match [#16970](https://github.com/pulumi/pulumi/pull/16970) - [engine] Allow provider to be unknown during preview [#16868](https://github.com/pulumi/pulumi/pull/16868) - [programgen] Add an organization intrinsic to PCL [#16948](https://github.com/pulumi/pulumi/pull/16948) - [cli/install] Add `--use-language-version-tools` flag to setup python version using pyenv during installation [#16855](https://github.com/pulumi/pulumi/pull/16855) - [cli/package] Allow `pulumi package add` to work with arbitrary schema sources [#16989](https://github.com/pulumi/pulumi/pull/16989) ### Bug Fixes - [auto] Fix panic in remote automation API [#16978](https://github.com/pulumi/pulumi/pull/16978) - [cli] Show a better message when logging out with `--all`. [#16998](https://github.com/pulumi/pulumi/pull/16998) - [docs] Use `ComponentResourceOptions` for components [#16968](https://github.com/pulumi/pulumi/pull/16968) - [docs] Show envvars for provider nested types. [#16984](https://github.com/pulumi/pulumi/pull/16984) - [sdk/go] Unmarshal pointers correctly if destination type is any [#16914](https://github.com/pulumi/pulumi/pull/16914) - [sdkgen/go] Use provided ImportBasePath for parameterized SDKs [#17036](https://github.com/pulumi/pulumi/pull/17036) - [sdk/nodejs] Fix type checking of `Output<Record<string, any>>` [#16959](https://github.com/pulumi/pulumi/pull/16959) - [sdk/nodejs] Fix NodeJS OOM detection condition - [sdk/nodejs] Prevent double close on OOM detection channel [#17043](https://github.com/pulumi/pulumi/pull/17043) - [sdkgen/nodejs] Set minimum version of core SDK when using parameterization [#17032](https://github.com/pulumi/pulumi/pull/17032) - [sdk/python] Fix the type of `StackReference.outputs` to be `Dict[str, any]` [#16956](https://github.com/pulumi/pulumi/pull/16956) ### Miscellaneous - [cli] Warn that query is planned to be removed [#16963](https://github.com/pulumi/pulumi/pull/16963) - [programgen] Improve the error message for an invalid method name |
||
---|---|---|
.. | ||
asset | ||
automation | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
npm | ||
proto | ||
provider | ||
queryable | ||
runtime | ||
tests | ||
tests_with_mocks | ||
types | ||
vendor | ||
.eslintrc.js | ||
.gitignore | ||
Makefile | ||
README.md | ||
biome.json | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
output.ts | ||
package.json | ||
resource.ts | ||
stackReference.ts | ||
tsconfig.json | ||
tsutils.ts | ||
typescript-shim.ts | ||
utils.ts | ||
version.ts | ||
yarn.lock |
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. Visit Pulumi's Download & Install to install the CLI.
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 any of the Current, Active and Maintenance LTS versions. 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 $HOME/.dev-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.