Add note on renaming environments#44271
Conversation
Added a note about the inability to rename environments and advised caution when choosing names.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
Pull request overview
Adds guidance to the GitHub Actions “Manage environments” documentation to warn readers that environment names can’t be changed after creation, helping prevent avoidable rework.
Changes:
- Added an in-page note warning that environments can’t be renamed later.
|
@theking2 I think a note on this is overkill. Adding it into the reusable under the "enter a name" step should be fine. You can put something like, "Keep in mind environment names can't be changed" anywhere after that first sentence. It should fit in perfectly with all the other caveats. |
|
Two things. At this point users might be more concerned with the contents, variables and secrets they store than the comparably insignificance of naming the environment. They should be as a typo or wrong decision here comes with a huge penalty of recreating the complete environment. Most if not all users intuitively assume even if they realise they've made a typo theu can correct it later on. Both the penalty and breaking a known pattern make this something to alert for. |
Added a note about the inability to rename environments and advised caution when choosing names.
Why:
It is not obvious at this point that renaming an environment later is not possible.
Check off the following: