pulumi/sdk/nodejs
Justin Van Patten 825629a4b5
Prepare for v3.134.0 release (#17298)
Tentative changelog:

### Features

- [engine] Generated and matched aliases are written to debug logs
  [#17280](https://github.com/pulumi/pulumi/pull/17280)

- [yaml] Update pulumi-yaml to 1.10.1
  [#17287](https://github.com/pulumi/pulumi/pull/17287)

- [cli/display] Show the count of unchanged resources
  [#17257](https://github.com/pulumi/pulumi/pull/17257)

- [auto/nodejs] Support an abort channel for gracefully canceling
operations
  [#16783](https://github.com/pulumi/pulumi/pull/16783)

- [auto/{nodejs,python}] Support refresh consistently in
up/preview/destroy
  [#17209](https://github.com/pulumi/pulumi/pull/17209)

- [cli/state] Support falling back to snapshot secret managers when
PULUMI_FALLBACK_TO_STATE_SECRETS_MANAGER is set
  [#17236](https://github.com/pulumi/pulumi/pull/17236)


### Bug Fixes

- [sdk/nodejs] Allow 'pulumi about' in nodejs projects to resolve
dependencies from package files by walking up the file tree
  [#17239](https://github.com/pulumi/pulumi/pull/17239)
2024-09-20 17:47:56 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation [nodejs] cancelation support for auto api (#16783) 2024-09-17 13:23:58 +00:00
cmd Add l1-output-map conformance test (#17301) 2024-09-19 10:08:31 +00:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
iterable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
log Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
npm Enable goheader rule and add missing license headers (#15473) 2024-09-09 12:05:45 +00:00
proto Add LanguageInfo to conformance tests (#17315) 2024-09-20 10:34:17 +00:00
provider Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
queryable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
runtime Couple of monitor support code cleanups from review (#17267) 2024-09-16 19:10:57 +00:00
tests [nodejs] cancelation support for auto api (#16783) 2024-09-17 13:23:58 +00:00
tests_with_mocks Fix NodeJS SDK mocking of custom resource reads (#16542) 2024-07-01 16:05:30 +00:00
types Replace deprecated read-package-tree with @npmcli/arborist (#15503) 2024-02-26 18:40:28 +00:00
vendor Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.eslintrc.js Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.gitignore Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
Makefile Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
README.md fix some links 2023-05-19 19:39:26 -07:00
biome.json Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
config.ts Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
errors.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
index.ts Removing x namespace from go/python/nodejs automation packages (#6518) 2021-04-14 19:32:18 +01:00
invoke.ts implement invoke transforms for NodeJS (#16688) 2024-07-18 08:41:39 +00:00
metadata.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
output.ts Updated nodejs and python sdk docs on outputs (#16885) 2024-09-09 08:11:25 +00:00
package.json Prepare for v3.134.0 release (#17298) 2024-09-20 17:47:56 +00:00
resource.ts Try and avoid serializing `runtime/resource.js` (#17247) 2024-09-12 16:27:53 +00:00
stackReference.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
tsconfig.json Revert "Implement `dependsOn` for invokes in the NodeJS SDK (#16560)" (#16642) 2024-07-12 10:16:55 +00:00
tsutils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
typescript-shim.ts Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
utils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
version.ts Prepare for v3.134.0 release (#17298) 2024-09-20 17:47:56 +00:00
yarn.lock Bump NodeJS SDK dependencies (#17214) 2024-09-10 09:23:20 +00: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. 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.