-
Notifications
You must be signed in to change notification settings - Fork 255
Document how to use components with local packages #16372
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,10 +66,10 @@ This clones the repo and executes the source, enabling you to use packages from | |
| #### Using `terraform-provider` | ||
|
|
||
| ```bash | ||
| pulumi package add terraform-provider hashicorp/random | ||
| pulumi package add terraform-provider hashicorp/random 3.5.1 | ||
| ``` | ||
|
|
||
| Refer to the [Terraform Provider documentation](/docs/iac/using-pulumi/pulumi-packages/terraform-provider/) for more details. | ||
| Refer to the [Any Terraform Provider documentation](/docs/iac/using-pulumi/pulumi-packages/terraform-provider/) for more details. | ||
|
|
||
| ## Using generated SDKs | ||
|
|
||
|
|
@@ -206,11 +206,42 @@ When working with local packages, it's important to understand how breaking chan | |
| To ensure stability, you should specify the version of both: | ||
|
|
||
| ```bash | ||
| pulumi package add terraform-provider hashicorp/random --version=3.5.1 | ||
| pulumi package add terraform-provider hashicorp/random 3.5.1 | ||
| ``` | ||
|
|
||
| This pins the Terraform provider version, protecting you from unexpected breaking changes when the underlying provider is updated. | ||
|
|
||
| ## Using components with local packages {#components-with-local-packages} | ||
|
|
||
| When creating a component that contains a local package, you must ensure the generated SDK is available to consumers of your component. This applies when your component uses: | ||
|
|
||
| - Any Terraform provider via [`terraform-provider`](/registry/packages/terraform-provider/) | ||
| - Another component that itself contains a local package | ||
| - Any other Pulumi plugin that generates code in the `sdk` folder | ||
|
|
||
| ### Requirements | ||
|
|
||
| 1. You must be using Pulumi 3.200.0 or later. | ||
| 1. In your component code, run `pulumi package add` to generate the upstream SDK. | ||
| 1. Ensure the generated code in the `sdk` folder is committed to version control. | ||
|
|
||
| ### Why this is necessary | ||
|
|
||
| When someone consumes your component, they need access to all the SDKs your component depends on. For published packages from the Pulumi Registry, these dependencies are automatically resolved. However, for local packages generated within your component, the generated SDK code must be available in your repository so that consumers can use it. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Very nice to have a "Why this is necessary" section 😍 |
||
|
|
||
| ### Example workflow | ||
|
|
||
| If you're building a component that uses a Terraform provider: | ||
|
|
||
| ```bash | ||
| cd my-component | ||
| pulumi package add terraform-provider hashicorp/random 3.5.1 | ||
| git add sdk/ | ||
| git commit -m "Add generated SDK for terraform-provider random" | ||
| ``` | ||
|
|
||
| Consumers of your component will then be able to use it without needing to regenerate the SDK themselves. | ||
|
|
||
| ## See also | ||
|
|
||
| For more information about developing and publishing your own packages, see the [Publishing Packages](/docs/iac/build-with-pulumi/publishing-packages/) guide. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems to be a 404, I think it's meant to be this: