zaproxy / zaproxy/actions-common
Make alert messages in issue more helpful
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 18
- Avg merge
- 4h 12m
- Merged PRs (30d)
- 5
Description
Hi there!
I've just implemented the GitHub Actions at a company, and there are some things which are cumbersome around the workflow. This issue specifically addresses the "Issue" created and missing information in it.
-
The individual alerts are hard to understand without more context.
To solve this, I would add information about the severity and add a link to the description for each alert. I already provided a PR (#43) for this.
-
It's hard to see which alerts are more and which are less important
For this, I would group the alerts by severity.
-
There's no good summary for the overall report
Here, I would recreate the summary table from the markdown report and add it to the top of the issue.
In addition, I would like to add a testing framework and some tests to be able to more confidently work on the code.
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 reviewing the existing issue-generation flow and PR #43, which already addresses additional alert context. Then identify where severity grouping and the summary table belong, and determine how a testing framework can cover the changes. Done means the issue includes clearer alert details, severity grouping, an overall summary, and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100