[bitnami/schema-registry] Add support for HTTPRoute resources#36458
[bitnami/schema-registry] Add support for HTTPRoute resources#36458attributeerror wants to merge 5 commits intobitnami:mainfrom
Conversation
Signed-off-by: Paul Reffell <attributeerror@amthst.dev>
Signed-off-by: Paul Reffell <attributeerror@amthst.dev>
Signed-off-by: Paul Reffell <attributeerror@amthst.dev>
|
Not sure why the 'update README' step is failing here, I've ran it locally & pushed the changes to the README as part of the PR checklist. If you can point me in the right direction as to why this is failing, I'll get it resolved :) |
bitnami/schema-registry/values.yaml
Outdated
| ## @param httpRoutes [array] HTTPRoute resources to create. | ||
| ## | ||
| httpRoutes: | ||
| ## @param httpRoutes.enabled [string] Enable this HTTPRoute |
There was a problem hiding this comment.
I found the cause of the CI/CD failure. The readme-generator-for-helm is crashing with TypeError: Cannot set properties of undefined (setting 'enabled')
The readme-generator is failing because it doesn't support @param comments for fields inside an [array].
Please remove all the ## @param lines inside the httpRoutes block (e.g., ## @param httpRoutes.enabled, ## @param httpRoutes.hostnames, etc.).
You should only document the main httpRoutes array itself. If you want to document the inner fields, please add them to the main description or use an ## e.g. block under the main httpRoutes parameter.
There was a problem hiding this comment.
@aravind4799 Thanks for the heads up - I've gone ahead and removed the @param comments from within the array & added an example section instead.
9d1d415 to
a7c6614
Compare
Signed-off-by: Paul Reffell <attributeerror@amthst.dev>
a7c6614 to
6c9c7dd
Compare
Signed-off-by: Bitnami Bot <bitnami.bot@broadcom.com>
Description of the change
This change adds the ability to create HTTPRoute resources for those using the Kubernetes Gateway API.
Benefits
This change will allow users of the chart to create and manage HTTPRoute resources as part of the deployment lifecycle, rather than having to do so separately.
Possible drawbacks
None known at this time.
Applicable issues
Additional information
N/A
Checklist
Chart.yamlaccording to semver. This is not necessary when the changes only affect README.md files.README.mdusing readme-generator-for-helm