History

Will Jones c496921d44 Enable some more linting rules (#17456 ) Issue #10659 lists a number of extra linting checks that we could enable in order to make our Go code more robust. This commit implements as many as seem sensible: * `durationcheck`, which checks for multiplication of `time.Duration`s, which can lead to unexpected behaviour (e.g. `time.Second * time.Second` is not one second) * `goprintffuncname`, which checks that `Printf`-like functions are appropriately suffixed with `f` to indicate as such * `tenv`, which checks for `os.Setenv` in tests where `t.Setenv` is generally a better solution * `wastedassign`, which checks for assignments whose values are never used (such as initial values before an `if` where both branches then overwrite the value) * `whitespace`, which checks for blank lines at the beginning and end of blocks such as functions, `if`s, `for`s and so on. This commit does not enable the following checks listed in #10659: * `wrapcheck`, which insists that third-party library errors are always `%w`rapped -- we have a lot of cases where we don't do this and it's probably a bit more involved than "just wrap them" in terms of making sure we don't break anything (maybe) * `predeclared`, which checks for shadowing of existing Go identifiers -- we use `old` and `new` a lot, especially in step generation, so this is probably a slightly bigger clean-up/one we might want to opt out of * `mnd` (magic number detection) -- we have a lot of failures on this * `nilnil` -- we only have a couple of failures on this; these could probably be handled with `//nolint` but for now I've opted not to take this route.		2024-10-03 17:37:13 +00:00
..
auto	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
common	Enable some more linting rules (#17456 )	2024-10-03 17:37:13 +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 StringMapMapMap to Go SDK (#17417 )	2024-09-29 10:05:30 +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	fix dll loading errors in windows CI (#17410 )	2024-10-02 08:43:42 +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.