docs(config): add warn about invalid characters in env name #20875
Conversation
This file contains 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
OskarStark
reviewed
Apr 10, 2025
Comment on lines
+597
to
+602
| .. warning:: | ||
|
|
||
| Some characters are not allowed in environment name, e.g. the | ||
| ``-`` character. If you try to use it, it will throw this exception: | ||
| The environment "%s" contains invalid characters, it can only contain | ||
| characters allowed in PHP class names. |
There was a problem hiding this comment.
I’m not sure we really need to document this — from my point of view, the exception is clear enough.
There was a problem hiding this comment.
The reason of this PR is that I got surprised that the doc did not mention it, and devs could easily use kebab-case for their environment name (especially on infrastructures they can't use locally).
But I agree, the exception is self-explanatory and devs will face this only once.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.