Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for each ThunderbirdComponentResource to describe resources #104

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ryanjjung
Copy link
Collaborator

One thing this PR does is resolve Issue #75.

Another thing it does is get rid of the concept of "outputs" entirely from our component resources. "Why?" you might ask. I had initially thought it might be a good way to get at programmatically generated data like IDs and ARNs that we don't control ourselves, the way you do in Terraform, but this is not the case. These outputs are only ever printed to the CLI, and there is no way of accessing them once you push them through the register_outputs call the Pulumi docs say we should make.

As it turns out, though, outputs aren't really a thing, as the Pulumi devs attest in this thread. There they describe a convention:

CyrusNajmabadi has taken to passing the empty object to registerOutputs unconditionally because it basically doesn't mean anything.

So this PR deprecates the use of "outputs". In the future, we'll remove it, opting for the convention of always using an empty dict.

@ryanjjung ryanjjung added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 11, 2025
@ryanjjung ryanjjung added this to the v0.0.12 milestone Feb 11, 2025
@ryanjjung ryanjjung self-assigned this Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant