Add pre-commit hook for validating release notes

[aaradhak]

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:

• This pre commit check was pending as part of this PR-934
• Add basic CI check for release notes YAML doc #628

[jlebon]

Not against this, but personally I don't feel like installing pre-commit just for this repo.

How about we also add it to the existing make syntax-check target?

[aaradhak]

I have made the changes to add the pre-commit hook to the make-syntax check. I think that is all would be needed. Please let me know if anything else needs to be changed.

[travier]

Hum, why is this adding pre-commit-check here?

[aaradhak]

based on the review comment earlier, I added the pre-commit check to the syntax check here.

[travier]

What's using this file?

[aaradhak]

This yaml is used by the pre-commit tool framework for managing pre-commit hooks. Pre-commit hooks run automatically before a commit is finalized. It requires the installation of pre-commit tool in the local environment

[jlebon]

Suggested change

	syntax-check: pre-commit-check
	@find streams updates -iname '*.json' | sort | xargs -n 1 python3 -c 'import json, sys; json.load(open(sys.argv[1]))'
	pre-commit-check:
	pre-commit run --all-files
	syntax-check: pre-commit-check
	@find streams updates -iname '*.json' | sort | xargs -n 1 python3 -c 'import json, sys; json.load(open(sys.argv[1]))'
	@find release-notes -iname '*.yaml' | sort | xargs -n1 python3 ci/check-release-notes.py

[aaradhak]

thanks for this input. I have made these changes.

[jlebon]

Since we now have it part of syntax-check, it's already covered by the existing validate.yml workflow, so we can get rid of the validate-release-notes.yml file.

Coincidentally, it looks like validation is failing. :)

[jlebon]

Still need to drop GitHub workflow.

[jlebon]

How about now we make this config use make syntax-check? That way it'll check more than just release notes.

[jlebon]

Thanks! LGTM though let's squash to a single commit?