docs(8.8): fix @param deprecation notices to reference specific sub-keys#6417
Merged
Conversation
Ian-wang-liyang
requested review from
Copilot and
hisImminence
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the usability of deprecation guidance in the Camunda Platform 8.8 Helm chart by making the @param deprecation notices point to the exact replacement sub-keys under global.license.secret, rather than referencing global.license.secret generically.
Changes:
- Updated
values.yamldeprecation notices to reference the specific replacement keys:global.license.key→global.license.secret.inlineSecretglobal.license.existingSecret→global.license.secret.existingSecretglobal.license.existingSecretKey→global.license.secret.existingSecretKey
- Kept schema and generated documentation aligned by updating the corresponding
descriptionfields invalues.schema.jsonand the parameter table inREADME.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| charts/camunda-platform-8.8/values.yaml | Makes deprecation notices point to the precise replacement sub-keys under global.license.secret.*. |
| charts/camunda-platform-8.8/values.schema.json | Updates schema description strings to match the refined deprecation guidance. |
| charts/camunda-platform-8.8/README.md | Updates the rendered parameters table to reflect the more specific deprecation messages. |
This file contains hidden or 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
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.
Which problem does the PR fix?
The deprecation notices for
global.license.key,global.license.existingSecret, andglobal.license.existingSecretKeyinvalues.yamlwere pointing users toglobal.license.secretgenerically, without specifying which sub-key to use as the replacement.What's in this PR?
Updated the
@paramdeprecation comments incharts/camunda-platform-8.8/values.yamlto reference the specific replacement sub-keys:global.license.key→global.license.secret.inlineSecretglobal.license.existingSecret→global.license.secret.existingSecretglobal.license.existingSecretKey→global.license.secret.existingSecretKeyChecklist
Before opening the PR:
make go.update-golden-only.After opening the PR: