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

Better document stack transformations #11784

Open
Tracked by #11197
joeduffy opened this issue May 5, 2020 · 2 comments
Open
Tracked by #11197

Better document stack transformations #11784

joeduffy opened this issue May 5, 2020 · 2 comments
Assignees
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).

Comments

@joeduffy
Copy link
Member

joeduffy commented May 5, 2020

The documentation on stack transformations is a bit "light." The best we have is this documentation page plus ancillary blog posts. The specifics of how transformations work is very different between languages, however -- particularly in Go and .NET where the weakly typed APIs require that you use reflection -- and the global stack transformation capability is mentioned only in passing.

We should do a better job at explaining this and probably link to language-specific API docs for detailed examples of how to use these in each of the languages.

@tenwit
Copy link
Contributor

tenwit commented May 15, 2020

Testing stack transformations took a lot of working out today. I'm probably doing it wrong, but in case I'm not, this might be something that could be added to the docs:

import { runInPulumiStack } from "@pulumi/pulumi/runtime/stack";
runInPulumiStack(() => {
  pulumi.runtime.registerStackTransformation(myStackTransformation);
  describe('test stuff', function() {
     ...
  });
  return new Promise<void>(() => {});
});

@lukehoban lukehoban self-assigned this Nov 20, 2020
@susanev susanev transferred this issue from pulumi/docs Apr 2, 2022
@susanev susanev added the kind/enhancement Improvements or new features label Apr 2, 2022
@susanev susanev added the area/docs Improvements or additions to documentation label Apr 27, 2023
@cnunciato cnunciato added the size/S Estimated effort to complete (1-2 days). label Feb 12, 2024
@cnunciato cnunciato added this to the 0.100 milestone Feb 12, 2024
@cnunciato cnunciato self-assigned this Feb 12, 2024
@interurban interurban modified the milestones: 0.100, 0.101 Feb 20, 2024
@interurban interurban removed this from the 0.101 milestone Mar 5, 2024
@sean1588 sean1588 transferred this issue from pulumi/pulumi-hugo May 10, 2024
@cnunciato
Copy link
Contributor

Useful internal discussion thread on this: https://pulumi.slack.com/archives/C011EMDQ8JE/p1719862660749509

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

6 participants