Overlay: Add CI workflow to check overlay annotations #19780
Merged
+23
−0
Conversation
This file contains hidden or 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
This was referenced Jun 16, 2025
kaspersv
force-pushed
the
kaspersv/overlay-java-annotations
branch
2 times, most recently
from
052023e to
81b677a
Compare
kaspersv
force-pushed
the
kaspersv/overlay-annotations-script-ci
branch
from
73bc5fb to
46ac2fd
Compare
There was a problem hiding this comment.
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
reviewed
Jun 27, 2025
navntoft
approved these changes
Jun 27, 2025
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.
This PR adds an actions workflow to enforce usage of the
add-overlay-annotations.pyscript to help maintain overlay annotations. This PR enables the script for Java.For https://github.com/github/codeql-core/issues/4951.