From 2bd95ba220b75384415c77b3feb464bcceecc10b Mon Sep 17 00:00:00 2001 From: Josh Kodroff Date: Fri, 24 Oct 2025 11:09:07 -0400 Subject: [PATCH] Clarify publishing packages guide introduction and scope MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .../packages/publishing-packages.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/content/docs/iac/guides/building-extending/packages/publishing-packages.md b/content/docs/iac/guides/building-extending/packages/publishing-packages.md index 49049126cad4..8b130c5ea390 100644 --- a/content/docs/iac/guides/building-extending/packages/publishing-packages.md +++ b/content/docs/iac/guides/building-extending/packages/publishing-packages.md @@ -21,14 +21,26 @@ aliases: - /docs/iac/build-with-pulumi/publishing-packages/ --- -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. +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: + +- A [component](/docs/iac/concepts/components) or related group of components +- A custom provider where you define the CRUD operations for each resource type +- A bridged provider, which wraps an existing Terraform provider and leverages its code to perform the CRUD operations for each resource type + +{{% notes type="info" %}} +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). +{{% /notes %}} {{% notes type="info" %}} -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. +If you are a cloud or SaaS provider interested in publishing a Pulumi provider or component, please [reach out to our partners team](/contact). {{% /notes %}} ## Prerequisites +{{% notes type="info" %}} +This guide assumes you're using GitHub to host your package's source code and GitHub Actions to publish various parts of your package. +{{% /notes %}} + - You need to [install Pulumi](/docs/install/). - You should be familiar with the Pulumi [Resource and Component model](/docs/concepts/resources/). - 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 - Bridge an existing Terraform Provider to use with Pulumi: [`pulumi/pulumi-tf-provider-boilerplate`](https://github.com/pulumi/pulumi-tf-provider-boilerplate) {{% notes type="info" %}} -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. +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. {{% /notes %}} ### Name your provider and repository