adding a debug pulumi providers page #4006
Conversation
|
Your site preview for commit c02e79c is ready! 🎉 http://pulumi-hugo-origin-pr-4006-c02e79ca.s3-website.us-west-2.amazonaws.com. |
|
|
||
| ### Starting the provider in debug mode | ||
|
|
||
| ### Example for GoLand |
There was a problem hiding this comment.
The two examples are on the same level ### than "Starting the provider"; should they be one lower?
|
|
||
|  | ||
|
|
||
| Upon startup, the provider should output a port number to the console (e.g., `12345`), indicating it is ready for a debugger to attach. |
There was a problem hiding this comment.
This sentence applies to all IDEs, not just vscode - can we make that clearer?
| Once Pulumi runs or tests are initiated with the `PULUMI_DEBUG_PROVIDERS` environment variable set, your IDE should automatically attach to the specified port and pause execution at your set breakpoints. | ||
|
|
||
| {{< notes type="warning" >}} | ||
| **Terminating the Provider Process**: Be cautious when terminating the provider process as it can get out of sync with the actual cloud resources. When in doubt, `pulumi refresh` will address this. |
There was a problem hiding this comment.
it can get out of sync
Not sure if every reader understands what "it" is here. Maybe say "the Pulumi state".
| aliases: | ||
| - /docs/guides/pulumi-packages/how-to-debug-providers/ |
There was a problem hiding this comment.
Since this is a new doc, we don't really need an alias (we can always use keywords to hook additional Algolia search queries). I'd also suggest having the URL be named debugging-provider-packages.md, as "troubleshoot" doesn't really apply here (debugging is something that's done during the normal course of development).
| aliases: | |
| - /docs/guides/pulumi-packages/how-to-debug-providers/ |
|
Your site preview for commit 3f82adb is ready! 🎉 http://pulumi-hugo-origin-pr-4006-3f82adb8.s3-website.us-west-2.amazonaws.com. |
|
Site previews for this pull request have been removed. ✨ |
Description
fixes #2218
Checklist: