feat: Add checker to ensure that env variable doc is up to date #5091
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
Signed-off-by: Simon Behar <[email protected]>
simster7
commented
Feb 11, 2021
hack/check-env-doc.sh
Outdated
| echo "Documented variable $x is not used anywhere"; | ||
| exit 1; | ||
| fi; | ||
| done |
There was a problem hiding this comment.
Need to add reverse case: "Variable in use is not documented"
There was a problem hiding this comment.
This is great to have! Thanks. Would you like to get #5080 merged so that we can test out the script in this PR?
1 task
Signed-off-by: Simon Behar <[email protected]>
simster7
commented
Feb 12, 2021
Signed-off-by: Simon Behar <[email protected]>
Signed-off-by: Simon Behar <[email protected]>
Signed-off-by: Simon Behar <[email protected]>
Signed-off-by: Simon Behar <[email protected]>
Signed-off-by: Simon Behar <[email protected]>
Signed-off-by: Simon Behar <[email protected]>
simster7
changed the title
hack/check-env-doc.sh
Outdated
| @@ -0,0 +1,33 @@ | |||
| #!/bin/bash | |||
|
|
|||
| echo "Checking env variables doc for completness..." | |||
There was a problem hiding this comment.
Perhaps be explicit about where the file is
simster7
commented
Feb 12, 2021
|
|
||
| echo "Checking docs/environment-variables.md for completeness..." | ||
|
|
||
| function check-used { |
Signed-off-by: Simon Behar <[email protected]>
alexec
approved these changes
Feb 12, 2021
alexec
pushed a commit
that referenced
this pull request
Feb 15, 2021
Signed-off-by: Simon Behar <[email protected]> Signed-off-by: Alex Collins <[email protected]>
Closed
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.
Checklist: