fix: update prefix regix validation #786
Conversation
|
| type = string | ||
| nullable = true | ||
| description = "The prefix to be added to all resources created by this solution. To skip using a prefix, set this value to null or an empty string. The prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It should not exceed 16 characters, must not end with a hyphen('-'), and can not contain consecutive hyphens ('--'). Example: prod-0405-ocp. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." | ||
| description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." |
There was a problem hiding this comment.
We should not be saying anything about using the string __NULL__ - To set null, consumers would use the UI option:
There was a problem hiding this comment.
Infact this is the terraform variable description - the description that is displayed in the projects UI is directly in the catalog JSON. For terraform description you can say null
solutions/quickstart/variables.tf
Outdated
| variable "prefix" { | ||
| type = string | ||
| description = "The prefix to be added to all resources created by this solution. To skip using a prefix, set this value to null or an empty string. The prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It should not exceed 16 characters, must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). Example: `prod-0205-ocpqs`. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." | ||
| description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." |
There was a problem hiding this comment.
I've updated the description with the information related to the changes, the PR is addressing the comments which are given here. Yes, the current regex does not allow a single alphabet as a prefix which I am resolving in this PR. |
|
/run pipeline |
solutions/quickstart/variables.tf
Outdated
| variable "prefix" { | ||
| type = string | ||
| description = "The prefix to be added to all resources created by this solution. To skip using a prefix, set this value to null or an empty string. The prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It should not exceed 16 characters, must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). Example: `prod-0205-ocpqs`. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." | ||
| description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To not use any prefix value, you can set to `null`. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)." |
There was a problem hiding this comment.
why did you remove the text that says: "To skip using a prefix, set this value to null or an empty string"? I don't know why this text is changing at all to be honest? Why would we not want to include the details of the regex pattern it needs to comply with?
There was a problem hiding this comment.
I've re-added the text "To skip using a prefix, set this value to null or an empty string". The details of the regex pattern will be shown in error message. Apart from removing the regex pattern details there's not much change in the description.
There was a problem hiding this comment.
In the UI, if the user insert a prefix with wrong pattern then the error shows the expected pattern as shown -
There was a problem hiding this comment.
The new variable description will look like this:
Earlier variable description was too long and looks like this:
|
/run pipeline |
|
🎉 This PR is included in version 3.57.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
3 participants
Description
This PR resolves the case when a user want to have a single alphabet as a prefix. It also updates the description of the prefix variable as mentioned here.
Release required?
x.x.X)x.X.x)X.x.x)Release notes content
Run the pipeline
If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.
Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:
Checklist for reviewers
For mergers