[Docs] CI for variables.yaml + CI for docs update #2457
Conversation
| - name: Run YAML Lint | ||
| run: | | ||
| pip install yamllint==1.35.1 | ||
| yamllint flow/scripts/variables.yaml |
There was a problem hiding this comment.
Can we pick a yaml linting tool that, like black, for python, you can just run to fix the formatting?
I'm not picky on yaml linting rules, I just want automatic update, like black does for python.
| else | ||
| echo "has_update=false" >> "$GITHUB_OUTPUT" | ||
| fi | ||
| git add . |
There was a problem hiding this comment.
this can add anything in the source folder, why add anything beyond FlowVariables.md?
There was a problem hiding this comment.
In fact, if anything under source control is change, except FlowVariables.md, this action should terminate, no?
| name: ORFS variables.yaml tester and linter | ||
|
|
||
| on: | ||
| push: |
There was a problem hiding this comment.
shouldn't this be pull-request, not on push(to a branch) test linting?
otherwise I don't think it will tests pull requests as only those with write access to the ORFS can create branches
The rest of the PR I think is designed to run after updates to master
There was a problem hiding this comment.
If we are catching mismatches on pull-request then I wouldn't expect we would ever need to have the docs-pr-update. The issue would be fixed in the original PR prior to merging.
Signed-off-by: Jack Luar <[email protected]>
…ction Signed-off-by: Jack Luar <[email protected]>
luarss
force-pushed
the
topic/yaml-tests
branch
from
b64ab9e
to
e26f811
Compare
Signed-off-by: Jack Luar <[email protected]>
Signed-off-by: Jack Luar <[email protected]>
|
@oharboe FlowVariables.md changes are detected in the update-pr section. Do you mean to shift it up to the lint section? |
|
I am thinking this is more linting than testing, yes. It is fast enough.... |
yamlfix.toml
Outdated
| @@ -0,0 +1,11 @@ | |||
| explicit_start = true | |||
| line_length = 120 | |||
There was a problem hiding this comment.
It looks like it is being wrapped at 80 characters not 120. 80 is preferable as it match Google style for c++. Does this do anything?
There was a problem hiding this comment.
Yes, it does. The command to run for check is yamlfix -c yamlfix.toml flow/scripts/variables.yaml --check, whereas for format is yamlfix -c yamlfix.toml flow/scripts/variables.yaml. Next PR should reflect line length 80.
Signed-off-by: Jack Luar <[email protected]>
Signed-off-by: Jack Luar <[email protected]>
Tracked in #2452
Fixes #2444