Skip to content

Commit 4fae39c

Browse files
jkodroffclaude
andcommitted
Clarify publishing packages guide introduction and scope
Improved the introduction to better explain the different types of Pulumi Packages that can be published (components, custom providers, and bridged providers). Added distinction between public packages and organizational components, directing users to the appropriate guide based on their needs. Also fixed spelling (customisation → customization) and improved formatting for better readability. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 9dd59b2 commit 4fae39c

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

content/docs/iac/guides/building-extending/packages/publishing-packages.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,26 @@ aliases:
2121
- /docs/iac/build-with-pulumi/publishing-packages/
2222
---
2323

24-
This guide will take you step-by-step through creating and publishing a Pulumi Package. You can use this guide to create any [type of Pulumi Package](/docs/guides/pulumi-packages#types-of-pulumi-packages): a component, custom provider, or an existing Terraform provider packaged for use within Pulumi. This guide assumes you're using GitHub to host your package's source code and GitHub Actions to publish various parts of your package.
24+
This guide will take you through the process to create and publish a [Pulumi Package](/docs/iac/concepts/packages) to the [Pulumi Registry](/registry). You can use this guide to publish the following types of Pulumi Packages:
25+
26+
- A [component](/docs/iac/concepts/components) or related group of components
27+
- A custom provider where you define the CRUD operations for each resource type
28+
- A bridged provider, which wraps an existing Terraform provider and leverages its code to perform the CRUB operations for each resource type
29+
30+
{{% notes type="info" %}}
31+
This guide is for creating packages for public consumption. If you are a looking for information on how to create and publish components for use within your organization, see [Build a Component](/docs/iac/guides/building-extending/components/build-a-component).
32+
{{% /notes %}}
2533

2634
{{% notes type="info" %}}
27-
If you are a cloud or SaaS provider interested in publishing a Pulumi provider or component, please [reach out partners team](/contact/?form=registry) to start publishing to the Pulumi Registry.
35+
If you are a cloud or SaaS provider interested in publishing a Pulumi provider or component, please [reach out to our partners team](/contact).
2836
{{% /notes %}}
2937

3038
## Prerequisites
3139

40+
{{% notes type="info" %}}
41+
This guide assumes you're using GitHub to host your package's source code and GitHub Actions to publish various parts of your package.
42+
{{% /notes %}}
43+
3244
- You need to [install Pulumi](/docs/install/).
3345
- You should be familiar with the Pulumi [Resource and Component model](/docs/concepts/resources/).
3446
- Pulumi Packages are multi-language: you can write your package once in either Go, Python, or TypeScript/JavaScript and then make it available to all Pulumi users, even if they use another language. To develop them, you need to have Git, Go, .NET, Python, and TypeScript installed on your system.
@@ -46,7 +58,7 @@ We've created some template repositories for you to use as a starting point for
4658
- Bridge an existing Terraform Provider to use with Pulumi: [`pulumi/pulumi-tf-provider-boilerplate`](https://github.com/pulumi/pulumi-tf-provider-boilerplate)
4759

4860
{{% notes type="info" %}}
49-
If you need access to a Terraform provider, but don't need the full customisation of a published provider, the ["Any Terraform Provider" Pulumi Provider](/registry/packages/terraform-provider) can provide instant access via locally generating SDKs.
61+
If you need access to a Terraform provider, but don't need the full customization of a published provider, the ["Any Terraform Provider" Pulumi Provider](/registry/packages/terraform-provider) can provide instant access via locally generating SDKs.
5062
{{% /notes %}}
5163

5264
### Name your provider and repository

0 commit comments

Comments
 (0)