mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/proto
History
Brandon Pollack 4fee2766e1
Add PULUMI_DEBUG_LANGUAGES support to go, python, and nodejs. (#17821) 
Extending the idea for PULUMI_DEBUG_PROVIDERS but no into language
providers.

There is a missing piece that providers didn't need which is the ability
to inform the language of the engine address for sending messages the
other direction (ie for logging) (previously this was a parameter).

I added a basic RPC that will let the engine inject that (or anything
else needed in the future). IMO we should actually rename this at some
point to "Initialize Language Host" and pass everything that way and NOT
via CLI arguments, but for now just this.

Other languages will have to be done in their own repositories after
this lands.

dotnet issue: pulumi/pulumi-dotnet#398
java issue:  pulumi/pulumi-java#1480
yaml issue: pulumi/pulumi-yaml#694
 		2024-12-11 08:50:52 +00:00
..
build-container Update node sdk to use typescript definitions for grpc and protobufs. (#14415) 2023-12-04 15:22:44 +00:00
google/protobuf Compile protobufs with "pulumi" namespace (#10074) 2022-07-12 14:45:03 +01:00
pulumi Add PULUMI_DEBUG_LANGUAGES support to go, python, and nodejs. (#17821) 2024-12-11 08:50:52 +00:00
.checksum.txt Add PULUMI_DEBUG_LANGUAGES support to go, python, and nodejs. (#17821) 2024-12-11 08:50:52 +00:00
README.md Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
generate.sh allow better grpc error messages from Python component providers (#17429) 2024-10-10 09:52:29 +00:00
grpc_version.txt Add getOrganization to nodejs and python (#10504) 2022-08-31 10:33:29 +01:00

README.md

Protobuf and gRPC interfaces

This package contains Protobuf definitions for the various types, messages and interfaces that Pulumi components use to communicate. These definitions serve as the source of truth for several parts of the wider codebase.

Code generation

:::{note} Code generated from Protobuf files is committed to the repository. If you change one or more .proto files, you should run make build_proto to regenerate the necessary stubs and commit the changes as part of the same piece of work. :::

The gh-file:pulumi#proto/generate.sh script in this directory (called by the build_proto target in the top-level gh-file:pulumi#Makefile) generates types and gRPC clients for the languages supported in this repository (Go, NodeJS/TypeScript and Python). Generated code is committed to the repository, typically in proto directories at the relevant use sites (e.g. gh-file:pulumi#sdk/nodejs/proto).

Documentation

We use the protoc-gen-doc plugin to protoc to generate Markdown documentation from the Protobuf files. This process is handled by the gh-file:pulumi#docs/Makefile in the docs directory and uses the gh-file:pulumi#docs/references/proto.md.tmpl template. Generated documentation ends up in the docs/_generated directory (which is .gitignored), so e.g. this index links to files in this folder.

Index

:::{toctree} :maxdepth: 1 :titlesonly:

/docs/_generated/proto/resource /docs/_generated/proto/provider /docs/_generated/proto/plugin /docs/_generated/proto/language /docs/_generated/proto/callback /docs/_generated/proto/loader /docs/_generated/proto/converter /docs/_generated/proto/analyzer /docs/_generated/proto/alias /docs/_generated/proto/engine /docs/_generated/proto/errors /docs/_generated/proto/source :::