Skip to content

docs: document --format report types and CSV header-only behavior (#132) - #141

Merged
advaitpatel merged 2 commits into
OWASP:mainfrom
gitcommit90:docs/issue-132-report-formats
Sep 7, 2026
Merged

docs: document --format report types and CSV header-only behavior (#132)#141
advaitpatel merged 2 commits into
OWASP:mainfrom
gitcommit90:docs/issue-132-report-formats

Conversation

@gitcommit90

Copy link
Copy Markdown
Contributor

Summary

  • Add a Report formats subsection with a table describing the four --format types.
  • Explicit note on zero-finding CSV headers.
  • Cross-links to Machine-readable output and JSON Schema sections.

Closes #132

Closes OWASP#132

Describe json/csv/pdf/html outputs and intentional zero-finding CSV headers.
Cross-reference machine-readable and SARIF sections.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 4, 2026
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions Bot added the stale No recent activity label Sep 3, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.51%. Comparing base (a2fe184) to head (cbe5cc3).
⚠️ Report is 30 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #141      +/-   ##
==========================================
+ Coverage   78.95%   80.51%   +1.56%     
==========================================
  Files          26       32       +6     
  Lines        4158     5169    +1011     
==========================================
+ Hits         3283     4162     +879     
- Misses        875     1007     +132     
Flag Coverage Δ
unittests 80.51% <ø> (+1.56%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@advaitpatel advaitpatel left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@advaitpatel
advaitpatel merged commit e2d33d4 into OWASP:main Sep 7, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation stale No recent activity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[GOOD FIRST ISSUE] Document --format output formats and CSV header-only behavior in README

3 participants