[Enhancement Request] - Improve debug messages for irrelevant workflow in some checks
Open
Nobody has claimed this yet.
enhancement
feature
- Dominant language
- Python
- Stars
- 210
- Forks
- 36
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 2
Description
Description
Currently there are 3 places where debug messages like
[DEBUG] Workflow <workflow_name> is not relevant. Skipping...
are printed out.
- https://github.com/oracle/macaron/blob/23c7fdbfeb15c5d286373be4471be1dc3ec8d231/src/macaron/slsa_analyzer/checks/build_as_code_check.py#L163
- https://github.com/oracle/macaron/blob/32aa0ccf0f552df3e90563653415bd38a3feac6a/src/macaron/slsa_analyzer/checks/github_actions_vulnerability_check.py#L110
- https://github.com/oracle/macaron/blob/4235041f706c7a811b5ddf369e26549bdea0206f/src/macaron/slsa_analyzer/checks/trusted_builder_l3_check.py#L126
Even though the context and reason why the message is printed out are different.
Proposed Feature
We can improve the debug message by adding a small description why a workflow is treated as irrelevant.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the relevant conditions around the referenced lines in src/macaron/slsa_analyzer/checks/build_as_code_check.py, github_actions_vulnerability_check.py, and trusted_builder_l3_check.py. Compare why each workflow is considered irrelevant and inspect nearby tests if available. Done means the three debug messages distinguish their respective reasons without changing check behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, security
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100