History

Thomas Gummerer 49efdabede allow component providers to return more detailed error messages (#17306 ) This is based on work from @lunaris and @EronWright, to allow us to return better error messages from component providers. The basic idea here is to allow attaching more error details on the RPC layer, and turn errors into diagnostic in the engine, to avoid the need to do fix the error up in every SDK and pretty print it. GRPC allows us to attach error details to the returned error to help us with that. These details can be error details such as specified in the `error_details` proto that comes with grpc, but can also take any other shape. Currently we only support pretty printing select types from that proto, but this can be extended in the future. On the implementation side, Go has a pretty nice API to create these errors, which we can just let users use directly. For Python and NodeJS the API is not so nice for this, so we need to encapsulate the error into a special exception, and then turn that into a proper GRPC message, using the magic `grpc-status-details-bin` metadata field. For both Python and NodeJS I've only implemented one class for errors so far, as I'm interested in some feedback on the API design first. I'm wondering if we should just let users specify the fields as tuples, and then add them to the `error_details` proto? Very open to ideas here. Closes: https://github.com/pulumi/pulumi/pull/16132 --------- Co-authored-by: Will Jones <will@sacharissa.co.uk> Co-authored-by: Eron Wright <eron@pulumi.com>		2024-09-25 15:38:36 +00:00
..
auto	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
common	allow component providers to return more detailed error messages (#17306 )	2024-09-25 15:38:36 +00:00
internal	Clean up stray files from #17267 (#17272 )	2024-09-16 23:29:30 +00:00
property	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
pulumi	Add packageReferences feature flag (#17153 )	2024-09-13 14:32:53 +00:00
pulumi-internal/netutil	try to choose a consistent port for debugging (#17271 )	2024-09-18 10:06:17 +00:00
pulumi-language-go	Add l2-primitive-ref conformance test (#17302 )	2024-09-24 08:42:24 +00:00
pulumix	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
Makefile	sdk/go: fix test_fast Makefile target (#16811 )	2024-07-26 10:25:04 +00:00
README.md	`pulumi update` => `pulumi up` (#2702 )	2019-05-06 14:00:18 -07:00

README.md

Pulumi Golang SDK

This directory contains support for writing Pulumi programs in the Go language. There are two aspects to this:

pulumi/ contains the client language bindings Pulumi program's code directly against;
pulumi-language-go/ contains the language host plugin that the Pulumi engine uses to orchestrate updates.

To author a Pulumi program in Go, simply say so in your Pulumi.yaml

name: <my-project>
runtime: go

and ensure you have pulumi-language-go on your path (it is distributed in the Pulumi download automatically).

By default, the language plugin will use your project's name, <my-project>, as the executable that it loads. This too must be on your path for the language provider to load it when you run pulumi preview or pulumi up.