Pulumi Upgrade Provider
PulumiOfficialPublished by Pulumi
- Skill
- Workflow
- Cloud and DevOps
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured workflow for upgrading Pulumi provider repositories to new upstream versions. It guides the user through running the upgrade-provider tool in a non-submitting mode, managing the repository state, resolving common errors such as patch conflicts or module mapping issues, and performing a final review before submission. The process ensures that generated code and documentation are correctly updated while maintaining the integrity of the provider's history and configuration.
What it does
- Executes the upgrade-provider tool to automate repository updates.
- Provides a systematic loop for identifying and fixing upgrade failures.
- Offers guidance on resolving patch conflicts and upstream dependency issues.
- Includes steps for auditing generated documentation for placeholders.
- Defines a review process for verifying changes before final submission.
- Outlines the procedure for submitting the upgrade via pull requests.
When to use it
- When a Pulumi provider needs to be upgraded to a new upstream version.
- When the upgrade-provider tool encounters errors during the automated process.
- When manual intervention is required to resolve patch conflicts or module mapping issues.
- When verifying the generated output of an upgrade before pushing changes.
Advantages
- Standardizes the upgrade process across different provider repositories.
- Provides clear error resolution paths for common upgrade blockers.
- Ensures that generated commits and documentation are reviewed for accuracy.
- Maintains a clean and reproducible workflow for provider maintenance.
Usage examples
- “Upgrade the current provider repository to the latest upstream version.”
- The agent initiates the upgrade-provider tool with the --no-submit flag, monitors the logs for errors, and provides a report on the local completion status.
- “I encountered a patch conflict while running the provider upgrade. How do I fix it?”
- The agent directs you to resolve the conflict within the upstream submodule, verify the patch intent, and use the check_in script before rerunning the upgrade.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/pulumi/pulumi-upgrade-provider/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip pulumi-upgrade-provider.zip -d .agents/skills
Documentation by Pulumi
Pulumi Upgrade Provider
Overview
Run upgrade-provider --no-submit, fix known failures, and rerun until success. During the run loop, the tool owns branch and generated-commit state but does not push or mutate GitHub. After success, review and correct the local result before submitting it using the plan printed by the tool.
Preflight
Record existing changes as the pre-upgrade baseline:
baseline_file="${TMPDIR:-/tmp}/upgrade-provider-$(basename "$PWD")-baseline.txt"
git status --short --untracked-files=all | tee "$baseline_file"Existing changes do not block the upgrade, but the tool stages broadly and may include them in generated commits. If practical, isolate clearly unrelated work in another branch or worktree, move local-only files, or add untracked local artifacts to .git/info/exclude. Otherwise proceed and carry this baseline into the final review. Do not add a repository .gitignore rule unless the path should be ignored for all contributors.
Keep the run log outside the repository so the tool cannot stage it.
Run Loop
Run from repo root:
log_file="${TMPDIR:-/tmp}/upgrade-provider-$(basename "$PWD").log"
upgrade-provider $ORG/$REPO --repo-path . --no-submit > "$log_file" 2> /dev/nullPreserve --no-submit on every retry.
Wait for completion (can take up to 10 minutes).
Check for errors by scanning the log for lines starting with
error::
if command -v rg >/dev/null 2>&1; then
rg -n '^error: ' "$log_file" || true
else
grep -n '^error: ' "$log_file" || true
fiOn a successful exit, first check whether the tool found that no upgrade was required:
if grep -Fq 'No actions needed' "$log_file"; then
echo 'No actions needed'
fiIf present, report that the provider is already current or the requested target is not an upgrade, then stop successfully. There is no local upgrade to review or submit.
Otherwise, extract and read the complete local-completion report from the captured stdout:
awk '/^Upgrade completed locally;/{found=1} found' "$log_file"This includes the proposed PR body and metadata, review commands, and every skipped submission action.
If failed, fix using this skill's
references/upgrade-provider-errors.md(from the skill folder, not the repo), then rerun with--no-submit. If upstream migrated from Terraform Plugin SDKv2 to Plugin Framework, use the migration-guide routing in that reference instead of treating the framework change alone as an architectural blocker. For upstreamgo getfailures involving ignoredreplacedirectives orunknown revision v0.0.0, rerun with--target-versionafter applying the documentedprovider/go.modreplacements; preserve the original major/non-major intent and add--majoronly for actual major version upgrades.If a fix requires creating/amending/removing/rebasing patches, use the
upstream-patchesskill for the patch workflow. Interrupted patch workflows must be checked in before rerunning.If you fixed a conflict, report exact edits (file paths + concrete changes or preserved intent).
Repeat until the tool prints
No actions neededor the local-completion report and proposed PR plan. This run must not push or mutate GitHub; a branch or PR from an earlier run may already exist.
When to Stop and Report Failure
Stop iterating and report failure if any of these conditions are met:
Command not found (exit code 127): The
upgrade-providertool is not in PATH.Same error 3 times: You've attempted to fix the same error 3 times without success.
Unknown error pattern: The error is not covered in
references/upgrade-provider-errors.mdand you cannot determine a safe fix.Ambiguous patch state: You cannot prove that every patch was applied and the target rebase completed.
Requires human judgment: The fix needs user input, such as choosing between multiple valid implementation approaches or making an architectural decision about module organization. Upstream breaking changes, deprecations, or framework migrations do not by themselves require stopping; stop only when implementing the upgrade presents an unresolved choice.
When stopping, report:
The error(s) encountered.
What fixes were attempted (with file paths and changes).
Why human intervention is needed.
Any partial progress.
Review the Local Upgrade
Use the tool's final report as the source of truth for the base branch, working branch, proposed PR title/body/metadata, and skipped submission actions.
Review a bounded summary first:
default_branch=$(gh repo view --json defaultBranchRef --jq .defaultBranchRef.name)
base_ref="origin/$default_branch"
git status --short --untracked-files=all
git log --oneline "$base_ref"..HEAD
git diff --shortstat "$base_ref"...HEAD
git diff --name-only "$base_ref"...HEAD | awk -F/ '{print $1}' | sort | uniq -cProvider upgrades can change thousands of generated SDK files. Do not print the full branch diff by default. Use path-limited git diff "$base_ref"...HEAD -- <paths> commands to inspect source, configuration, patch, schema, and unexpected directories. For generated SDKs, inspect summaries or targeted files unless a full diff is necessary.
Cross-check the final branch against the pre-upgrade baseline:
baseline_file="${TMPDIR:-/tmp}/upgrade-provider-$(basename "$PWD")-baseline.txt"
[ ! -f "$baseline_file" ] || cat "$baseline_file"For every pre-existing path included in the branch, decide whether it belongs in the upgrade PR. Keep intentional paths; move unrelated work to another branch/worktree or remove it from the unpublished upgrade history before pushing. A separate commit on the same branch isolates history but does not remove the path from the PR, and unstaging alone is insufficient after the tool has committed it. Revoke any exposed credential even if the history is rewritten.
MUST audit generated doc replacements for unresolved placeholders before publication:
if [ -f provider/replacements.json ]; then
if command -v rg >/dev/null 2>&1; then
rg -n '"new":.*TODO|TODO' provider/replacements.json || true
else
grep -En '"new":.*TODO|TODO' provider/replacements.json || true
fi
fiIf any TODO is found in provider/replacements.json:
Treat it as a pre-submission blocker; replacement values render into generated docs.
Inspect each
old/newpair and replaceTODOwith concrete Pulumi-facing wording, usuallyPulumi,this provider, orthe provider.Run focused validation if the repo has the test:
cd provider && go test -v -run TestReplacementDoesNotIncludeTodos .If the upgrade changed patches, review the applied commits and then exit checkout mode:
./scripts/upstream.sh checkout
git -C upstream log --oneline pulumi/checkout-base..pulumi/patch-checkout
# Inspect relevant commits with git -C upstream show <sha>.
./scripts/upstream.sh check_inList commit SHAs/titles, summarize each intent, and call out behavioral changes or risks. check_in is mandatory after review; leaving upstream on pulumi/patch-checkout blocks the next safe tool run.
Run focused validation for every manual fix and add focused follow-up commits.
Require a clean working tree before submission.
Submit the Reviewed Upgrade
The local-completion report lists the proposed PR metadata and every skipped action. MUST reproduce all applicable actions, not only PR creation:
Preserve the proposed title, body, release label, reviewers, and assignee. Never decide, infer, or change the release label: provider upgrades follow the upstream version transition, so the label represents that version delta rather than the agent's assessment of whether individual changes are breaking. For example, upstream
v0.9.0tov0.10.0remains a minor upgrade even when it contains breaking behavioral changes. Use exactly the label emitted byupgrade-provider, report any concern to reviewers without changing the metadata, and never add--majorunless the upstream target crosses the current upstream major version.If fixes unblocked the upgrade, append this section to the proposed body before submission when practical:
---
### Fixes applied to unblock upgrade
- <list concrete unblocker edits here, with file paths and intent>Push only after review. The tool reports an unconditional force-push; manual submission intentionally uses the safer lease-protected equivalent unless the user explicitly approves overwriting newer remote work:
branch=$(git branch --show-current)
git push --set-upstream origin "$branch" --force-with-leaseUse
ghto create or update the PR as described by the report.Assign listed upgrade issues to the PR assignee when requested.
For bridge upgrades, close listed superseded bridge PRs and comment with the replacement PR URL.
Fetch and report the final PR URL:
gh pr view --json url --jq .url || gh pr list --head "$(git branch --show-current)" --json url --jq '.[0].url'If the fixes section was not included before submission, append it without replacing the existing body:
repo=$(gh repo view --json nameWithOwner --jq .nameWithOwner)
pr_number=$(gh pr view --json number --jq .number)
gh pr view --json body --jq .body > /tmp/pr_body.txt
cat <<'EOF' >> /tmp/pr_body.txt
---
### Fixes applied to unblock upgrade
- <list concrete unblocker edits here, with file paths and intent>
EOF
gh api -X PATCH "repos/$repo/pulls/$pr_number" --raw-field body="$(cat /tmp/pr_body.txt)"Use REST (gh api) instead of gh pr edit to avoid GraphQL project-card errors. Keep existing body content; only append.
Notes
git rebase --continue --no-editis not supported in older git versions. Usegit rebase --continueand accept the existing commit message.To avoid the editor prompt during
git rebase --continue, run it withGIT_EDITOR=true(orGIT_EDITOR=:).
Guardrails
Never commit, push, or create branches manually during the upgrade-provider run loop.
After
--no-submitsucceeds, focused correction commits and manual submission are permitted.Never use
./scripts/upstream.sh init -funless intentionally discarding interrupted patch work; it is destructive.Do not leave
upstreamin checkout or an active Git operation before submission.Do not stash changes; use a clean worktree or remove unrelated artifacts instead.
References
Use this skill's
references/upgrade-provider-errors.md(from the skill folder, not the repo) for interrupted patch state, patch conflict, SDKv2-to-Plugin-Framework migration, ignored upstream replacement, vendored upstream dependency, .NET duplicate file, and new module mapping fixes.
Files
- ATTRIBUTION.mdAdded by AutoGineer890 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md10.9 KiB
- agents/openai.yaml287 B
- references/upgrade-provider-errors.md19.6 KiB
- use_cases.yaml1.7 KiB
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs a command-line tool
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Pulumi
- Publisher
- Pulumi (Official)
- Source
- pulumi/agent-skills · package-maintenance/skills/pulumi-upgrade-provider · commit 82f222a
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Pulumi or Pulumi.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download pulumi-upgrade-provider.zip