CI check for release notes YAML docs #934
Conversation
|
Maybe we should make the Python script take all 3 files as input and check them all and report all errors directly to avoid a back and forth. Maybe we should make it a commit hook as well. I vaguely remember that we have one here or something similar. |
Yes, I am intending to input all 3 files as input and check all at once instead of back n forth. For the purpose of testing, I am using this approach now. Also, I thought about the commit hook part as well. I am trying to figure out how to implement it here. |
aaradhak
changed the title
I tested this script with few invalid inputs and it seems to capture the errors as expected. |
This is a CI check for the release notes of next.yml, stable.yml and testing.yml to catch the syntax and schema errors in these files. Ref: coreos#628
|
I will be looking into adding the pre-commit hook post merge. |
|
Thanks for working on this! |
- This is a pre-commit hook using `pre-commit` framework to validate release notes YAML files. - The hook checks for correct structure, formatting and required fields in the `release-notes` directory. - This ensures consistency and correctness in release notes before committing changes. Ref: coreos#934 (comment)
- This is a pre-commit hook using `pre-commit` framework to validate release notes YAML files. - The hook checks for correct structure, formatting and required fields in the `release-notes` directory. - This ensures consistency in release notes before committing changes. Ref: coreos#934 (comment)
- This is a pre-commit hook using `pre-commit` framework to validate release notes YAML files. - The hook checks for correct structure, formatting and required fields in the `release-notes` directory. - This ensures consistency in release notes before committing changes. - Added release notes validation to the `make syntax-check` target Ref: coreos#934 (comment)
- This is a pre-commit hook using `pre-commit` framework to validate release notes YAML files. - The hook checks for correct structure, formatting and required fields in the `release-notes` directory. - This ensures consistency in release notes before committing changes. - Added release notes validation to the `make syntax-check` target Ref: coreos#934 (comment)
- This is a pre-commit hook using `pre-commit` framework to validate release notes YAML files. - The hook checks for correct structure, formatting and required fields in the `release-notes` directory. - This ensures consistency in release notes before committing changes. - Added release notes validation to the `make syntax-check` target Ref: coreos#934 (comment)
This is a CI check for the release notes of next.yml, stable.yml and testing.yml to catch the syntax and schema errors in these files.
Ref: #628