Overlay: Add CI workflow to check overlay annotations

[kaspersv]

This PR adds an actions workflow to enforce usage of the add-overlay-annotations.py script to help maintain overlay annotations. This PR enables the script for Java.

For https://github.com/github/codeql-core/issues/4951.

[Copilot]

Pull Request Overview

This PR introduces a new CI workflow to enforce the proper usage of overlay annotations for Java via the add-overlay-annotations.py script.

• Added a GitHub Actions workflow to run on push and pull_request events for main and rc/* branches.
• The workflow checks overlay annotations by invoking a Python script with a Java flag.

Comments suppressed due to low confidence (2)

.github/workflows/check-overlay-annotations.yml:17

• The job id 'sync' is unclear in the context of checking overlay annotations. Consider renaming it to something more descriptive like 'check-overlay-annotations'.

  sync:

.github/workflows/check-overlay-annotations.yml:22

• Verify that the script path 'config/add-overlay-annotations.py' is correct relative to the repository structure. If the script is located elsewhere, update the command to reflect the correct path.

        run: python config/add-overlay-annotations.py --check java

[ginsbach]

This looks convincing, but I don't have much experience with CI workflow definitions, so cannot judge whether it works.

[kaspersv]

@ginsbach In case you are interested, you can see an example of a successful run here and a failed run here (from before main was merged in).

[ginsbach]

@ginsbach In case you are interested, you can see an example of a successful run here and a failed run here (from before main was merged in).

Thanks, that convinces me!

[navntoft]

I still have a limited experience with CI checks in this repo, but it looks fine AFAICT, mirroring the structure of e.g. check-query-ids.yml.