[docs-only] Update the check-env-var-annotation script#12120
Merged
Conversation
mmattel
force-pushed
the
update_envvar_check_script
branch
from
f643a50 to
7087d77
Compare
|
2403905
approved these changes
Mar 17, 2026
ownclouders
pushed a commit
that referenced
this pull request
Mar 17, 2026
[docs-only] Update the check-env-var-annotation script
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
2 participants
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.
Identified by @2403905 while working on #12108
When a new envvar is introduced, we have a rule that the
introductionVersionneeds to be populated.The dev docs have a description for this and a one liner "rule guide" - but this can be overseen easily or forgotten.
When CI runs, there is a step at the very beginning to check if envvar descriptions or introduction version texts meet the requirement. But if there is an error detected, it only prints out that it did not pass on the particular envvar but does not give any hint about the rules.
This PR fixes this by updating the envvar checking script that prints out go/nogo examples in case of errors identified for ease of fixing.
@2403905 I have tested the script using a local clone of #12108 in a state where CI complained.