98181d7e71
Tentative changelog: ## (2024-10-01) ### Features - [backend/{diy,service}] Send secrets managers as initial state when creating stacks [#17387](https://github.com/pulumi/pulumi/pull/17387) - [sdk/python] Search upwards for pyproject.toml when using Poetry [#17388](https://github.com/pulumi/pulumi/pull/17388) ### Bug Fixes - [cli/config] Improve usage string for config env add/rm commands [#17407](https://github.com/pulumi/pulumi/pull/17407) - [cli/new] Check zipped templates for `Pulumi.yaml` files [#17437](https://github.com/pulumi/pulumi/pull/17437) - [engine] Disable the enviromental GITHUB_TOKEN on 401 responses [#17351](https://github.com/pulumi/pulumi/pull/17351) - [engine] Fix a panic when multiple component provider construct calls fail [#17439](https://github.com/pulumi/pulumi/pull/17439) - [sdkgen/go] Fix nested string map map map properties [#17417](https://github.com/pulumi/pulumi/pull/17417) - [sdk/nodejs] Fix dependency installation for nodejs projects with a main property [#17391](https://github.com/pulumi/pulumi/pull/17391) - [sdk/python] Add missing package_ref paramater to ProviderResource [#17432](https://github.com/pulumi/pulumi/pull/17432) ### Miscellaneous - [sdkgen] Validate schema version is provided when package supports packing [#17420](https://github.com/pulumi/pulumi/pull/17420) - [sdk/python] Replace asyncio.ensure_future with create_task [#17406](https://github.com/pulumi/pulumi/pull/17406) - [sdkgen/{nodejs,python}] Bump minimum valid SDK version to v3.134.1 so that output-invokes work and maintain secrets [#17390](https://github.com/pulumi/pulumi/pull/17390) |
||
---|---|---|
.. | ||
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.