Fix script to handle SARIF file recategorization#187
Merged
PiotrKorkus merged 2 commits intoeclipse-score:mainfrom Apr 16, 2026
Merged
Fix script to handle SARIF file recategorization#187PiotrKorkus merged 2 commits intoeclipse-score:mainfrom
PiotrKorkus merged 2 commits intoeclipse-score:mainfrom
Conversation
|
The created documentation from the pull request is available at: docu-html |
Saumya-R
force-pushed
the
saumya_update_workflow
branch
from
1ad3c92 to
0bfca2d
Compare
Saumya-R
force-pushed
the
saumya_update_workflow
branch
2 times, most recently
from
45c4e88 to
9532b07
Compare
Saumya-R
requested review from
AlexanderLanin,
FScholPer,
MaximilianSoerenPollak,
PiotrKorkus,
antonkri,
dcalavrezo-qorix,
lurtz,
nradakovic,
opajonk and
pawelrutkaq
as code owners
PiotrKorkus
requested changes
Mar 31, 2026
Saumya-R
force-pushed
the
saumya_update_workflow
branch
5 times, most recently
from
bf66e81 to
c36b2c1
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the multi-repo CodeQL workflow from ad-hoc shell scripts to Python tooling, adds GitPython-based checkout support, and makes SARIF recategorization/filtering more robust in CI.
Changes:
- Replace
parse_repos.sh,checkout_repos.sh, andrecategorize_guidelines.shwith Python equivalents underscripts/tooling/cli/workflow/. - Introduce
scripts/tooling/lib/git_operations.py(GitPython-based shallow clone with optional token auth) and addGitPythonas a dependency. - Update the GitHub Actions workflow to use the new Python scripts, add timeouts/debug steps, and expand CodeQL
paths-ignore.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/workflow/recategorize_guidelines.sh | Removed legacy shell-based SARIF recategorization script. |
| scripts/workflow/parse_repos.sh | Removed legacy jq-based repo parsing script. |
| scripts/workflow/checkout_repos.sh | Removed legacy git clone loop script. |
| scripts/tooling/requirements.in | Adds GitPython to the tooling dependency inputs. |
| scripts/tooling/lib/git_operations.py | New GitPython-based clone helper used by workflow checkout. |
| scripts/tooling/cli/workflow/recategorize_guidelines.py | New Python SARIF recategorization + filtering step. |
| scripts/tooling/cli/workflow/parse_repos.py | New Python generator for repos.json + GHA outputs. |
| scripts/tooling/cli/workflow/checkout_repos.py | New Python repo checkout runner using git_operations. |
| scripts/tooling/cli/workflow/init.py | Adds a placeholder module for workflow CLI organization. |
| .github/workflows/codeql-multiple-repo-scan.yml | Switches workflow to Python scripts; adds caching/timeouts/cleanup and adjusts checkout order. |
| .github/codeql/codeql-config.yml | Expands paths-ignore to reduce irrelevant CodeQL scanning scope. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
PiotrKorkus
requested changes
Apr 9, 2026
Contributor
PiotrKorkus
left a comment
PiotrKorkus
left a comment
There was a problem hiding this comment.
- Make codeql analysis executable with bazel command and use it in workflow.
- Raise errors directly instead of returning True/False and exitting from different place in code when there is no option to recover.
- Inconsistent use of prints and logging.
Comment on lines
+97
to
+102
| - name: Cleanup repository checkouts | ||
| if: always() | ||
| run: | | ||
| echo "Cleaning up checked out repositories to free disk space" | ||
| rm -rf repos/ | ||
| df -h |
Contributor
Author
There was a problem hiding this comment.
- Frees up ~several GB of disk space (8 large repositories)
- Subsequent steps (recategorization, HTML generation) only need SARIF results, not source code
Added these for disk space freeing.
Saumya-R
force-pushed
the
saumya_update_workflow
branch
from
374e0f3 to
eec9f99
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Saumya-R
force-pushed
the
saumya_update_workflow
branch
from
60b2e88 to
4cc33bf
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+34
to
+63
| def validate_paths(): | ||
| """ | ||
| Validate that required files exist. | ||
|
|
||
| Note: Only validates files needed for recategorization if SARIF exists. | ||
| Returns: | ||
| True if validation passes or SARIF doesn't exist, False on critical errors | ||
| """ | ||
| # First check if SARIF file exists - if not, nothing to recategorize | ||
| if not Path(SARIF_FILE).exists(): | ||
| print(f"Info: SARIF file not found at {SARIF_FILE}", file=sys.stderr) | ||
| return False # Signal to skip recategorization | ||
|
|
||
| # SARIF exists, check for recategorization dependencies | ||
| optional_files = [ | ||
| RECATEGORIZE_SCRIPT, | ||
| CODING_STANDARDS_SCHEMA, | ||
| SARIF_SCHEMA, | ||
| ] | ||
|
|
||
| required_files = [ | ||
| CODING_STANDARDS_CONFIG, | ||
| ] | ||
|
|
||
| # Check required files (fail if missing) | ||
| for file_path in required_files: | ||
| if not Path(file_path).exists(): | ||
| print(f"Error: Required file not found: {file_path}", file=sys.stderr) | ||
| return False | ||
|
|
There was a problem hiding this comment.
validate_paths() returns False both when the SARIF file is missing (a non-error “skip” condition) and when a required file is missing (a real error). In main() these are treated the same and exit 0, which can hide misconfiguration. Consider returning a tri-state (e.g. enum) or raising on missing required files so CI fails when SARIF exists but config is missing.
PiotrKorkus
requested changes
Apr 16, 2026
adding GitPython lib cleaning the files for redundant made Codeql executable with bazel fixing bzel run issues adding a version removing timeout addresses several issues related to environment-specific paths and execution context removing the ref
Saumya-R
force-pushed
the
saumya_update_workflow
branch
from
16f4461 to
edcaf22
Compare
PiotrKorkus
approved these changes
Apr 16, 2026
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
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 migrates the multi-repo CodeQL workflow from ad-hoc shell scripts to Python tooling, adds GitPython-based checkout support, and makes SARIF recategorization/filtering more robust in CI.
Changes:
Replace parse_repos.sh, checkout_repos.sh, and recategorize_guidelines.sh with Python equivalents under scripts/tooling/cli/workflow/.
Introduce scripts/tooling/lib/git_operations.py (GitPython-based shallow clone with optional token auth) and add GitPython as a dependency.
Update the GitHub Actions workflow to use the new Python scripts, add timeouts/debug steps, and expand CodeQL paths-ignore.
Closes: #148
Closes: #149