[Epic] Single-repository Pulumi Packages

[infin8x]

Hello!

• Vote on this issue by adding a 👍 reaction
• If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Epic details

Today, a Pulumi Package's contents are spread across a few places (see list below). To make it easier for anyone in the Pulumi Community to author a package and prepare for #206, we should update our publishing processes to source all of that content from the package's repository. We should then move the content for all of our existing packages into their repositories.

• The code and the schema are in the package's repository
• The API documentation (generated from the schema) is in https://github.com/pulumi/docs
• The hand-written documentation (Overview, Installation & Configuration) is in https://github.com/pulumi/registry
• The how-to guides are in https://github.com/pulumi/examples

Work items

• Interested Parties
• Quality plan
• Generate Pulumi Package API documentation inside the repository #223
• Enable Overview, Installation & Configuration pages to be stored inside the repository #224
• make it easier for folks to add how-to guides #221
• Update the Pulumi Packages publishing guide to match the changes made in this Epic
• Update any relevant Pulumi developer documentation to match the changes made in this Epic

Launch readiness 🎁

Link

[leezen]

Reading through this, I think we may need to find a way to provide a cut line between registry and the packages side of things. For example, building out an API/SDK that packages can consume as part of their publishing workflows, so a lot of this epic would break down into two sides: building the relevant API/SDK and integrating it as part of package publishing. Otherwise, I'd be afraid that we end up coupling these together too tightly.

[infin8x]

Agreed. I think I'd like a few things to be true:

• The complete source contents (code and docs) of a Pulumi Package live within a single repo.
• We should provide, as part of the functionality offered by the Pulumi Packages product, tooling that takes that repository and gives you all of the outputs you need to publish the package (plug-in, 3 packages, Go module tagged appropriately).

At that point, you have a complete package that can be published to package registries of your choice, and you can read the schema for API docs and consult the Markdown in the repo for the overview, install info, and any how-to guides. In my mind, this is the line between the Pulumi Packages product and the Pulumi Registry product.

Then, for Registry, I'd want the following to be true:

• There is publishing tooling that takes the repo, publishes it to Registry, and helps you publish all the SDK packages to the appropriate public repository

Thoughts?

[susanev]

we are going a different direction with this, so closing.