Document additional step for project-namespaced config when renaming stack project

[Copilot]

When renaming a stack's project using a fully-qualified name (e.g., robot-co/new-project-name/production), the stack settings file is renamed but project-namespaced configuration keys retain the old project prefix.

Changes

• Converted single paragraph to ordered list format for clarity
• Added explicit step to update project-namespaced configuration variables in stack settings files (e.g., Pulumi.production.yaml)
• Updated code formatting to use backticks consistently for inline code and file names

Example

When renaming from old-project to new-project, configuration keys like old-project:apiKey must be manually updated to new-project:apiKey in the stack settings file.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• cdn.cypress.io
  • Triggering command: /usr/local/bin/node /usr/local/bin/node index.js --exec install (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

fix this on a new feature branch: #16958

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[pulumi-bot]

Your site preview for commit 04efa09 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16960-04efa09f.s3-website.us-west-2.amazonaws.com.

[meagancojocar]

revised proposal: Note: Because renaming a stack will change the value of getStack() inside a Pulumi program, if this
name is used as part of a resource's name, the next pulumi up will want to delete the old resource and
create a new copy. For now, if you don't want these changes to be applied, you should rename your stack
back to its previous name.

You can also rename the stack's project by passing a fully-qualified stack name. For example:
robot-co/new-project-name/production. However, in order to update the stack again, you would also need to:

1. Update the name field in Pulumi.yaml to reflect the new project name.
2. Update any project-namespaced configuration keys in the stack settings file (e.g., Pulumi.production.yaml) from old-project:key to new-project:key.

[meagancojocar]

@claude read the above comment and make the changes + review this

[claude]

Claude finished @meagancojocar's task in 1m 38s —— View job

---

Tasks

• Read current file content and Meagan's revised proposal
• Read repository style guide
• Apply revised text changes to the documentation
• Review changes for style compliance
• Commit and push changes
• Provide final review feedback

Changes Applied

I've updated the documentation based on Meagan's revised proposal. The changes include:

1. File name formatting: Changed from backticks to italics for Pulumi.yaml and Pulumi.production.yaml (more appropriate for file references in prose)
2. Punctuation: Added comma after "e.g.," for proper style
3. Removed unnecessary comma: Removed comma after "Pulumi.yaml" before "to reflect"
4. Clarified terminology: Changed "configuration variables" to "configuration keys" (more precise)
5. Added concrete example: Included the specific format old-project:key to new-project:key to make the required change crystal clear

Review Findings

Style Compliance ✅

• Ordered list format with 1. numbering per AGENTS.md
• Proper use of italics for file names per documentation conventions
• Inline code formatting for configuration key examples
• Sentence case maintained throughout
• Comma after "e.g.," follows standard style

Content Quality ✅

• The addition of the concrete example (old-project:key to new-project:key) significantly improves clarity
• The two-step process is now clearly enumerated
• Users will understand exactly what needs to be updated in their stack settings files

Technical Accuracy ✅

• Correctly identifies that project-namespaced config keys use the format project-name:key
• Accurately describes the manual update requirement after renaming

Changes Summary

Updated content/docs/iac/cli/commands/pulumi_stack_rename.md:23-24 with improved formatting and a concrete example of the configuration key update requirement.

Commit: 7596db4

---

| Branch: copilot/fix-issue-16958

[pulumi-bot]

Your site preview for commit 7596db4 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16960-7596db48.s3-website.us-west-2.amazonaws.com.

[claude]

Documentation Review

I've reviewed the changes to the stack rename documentation. The update addresses a real gap in the documentation by documenting the need to update project-namespaced configuration keys.

Issues Found

Line 20: Formatting inconsistency

The file name Pulumi.yaml uses italic formatting, while it should use backticks for consistency with code/file references per the style guide.

Location: content/docs/iac/cli/commands/pulumi_stack_rename.md:23

1. Update the `name` field in `Pulumi.yaml` to reflect the new project name.

Line 21: Formatting inconsistency

Similarly, the file name Pulumi.production.yaml and the configuration key format should use consistent backtick formatting for code elements.

Location: content/docs/iac/cli/commands/pulumi_stack_rename.md:24

1. Update any project-namespaced configuration keys in the stack settings file (e.g., `Pulumi.production.yaml`) from `old-project:key` to `new-project:key`.

Positive Notes

• The conversion from a paragraph to an ordered list significantly improves readability and makes the steps actionable
• The additional step about updating project-namespaced configuration keys directly addresses the issue reported in Pulumi Stack Rename docs: additional undocumented steps #16958
• The numbered list format follows the repository convention of using 1. for all items
• The sentence structure is clear and concise

Recommendations

Apply the formatting suggestions above to maintain consistency with the style guide's requirement to use backticks for CLI commands, file names, and code elements (per STYLE-GUIDE.md line 238).

---

If you need me to make these fixes or want additional review, just mention @claude!