70b144d8c3
This change adds comments in the protobuf definitions of the Engine<->Provider protocol to highlight that the `news` value passed to the provider may be influenced by the state, specifically the old inputs stored in the state, in an Update scenario, and pre-processed to implement ignoreChanges at the engine level. This was not entirely obvious when analyzing provider behavior, and it helps having this documented in the proto files. Note that this is especially confusing since the engine is also passing ignoreChanges to the provider as if to say "please implement it on your end". This is indeed something that is used to suppress any residual diffs, say in Terraform-bridged providers, but what's not obvious is that the engine performs a bit of processing here already. The relevant implementation seems to be around https://github.com/pulumi/pulumi/blame/master/pkg/resource/deploy/step.go#L1407 --------- Co-authored-by: Ian Wahbe <ian@wahbe.com> |
||
|---|---|---|
| .. | ||
| 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.