name	add-reporter
description	Add a new output reporter to MegaLinter. Use when adding support for a new CI system or output format.
allowed-tools	Read Grep Glob Edit Write
argument-hint	["reporter-name"]
model	sonnet

Guide through adding a new reporter named $ARGUMENTS to MegaLinter.

Steps:

Create the class in megalinter/reporters/<Name>Reporter.py extending megalinter.Reporter
Implement required methods:
- manage_activation() — check env var like <NAME>_REPORTER=true to enable/disable
- produce_report() — generate the report output
- Optionally: initialize(), add_report_item()
Register the reporter — check how existing reporters are discovered and loaded in megalinter/MegaLinter.py
Reference patterns from existing reporters:
- Simple output: ConsoleReporter.py, TapReporter.py
- CI integration: GithubCommentReporter.py, GitlabCommentReporter.py
- File output: JsonReporter.py, SarifReporter.py
- External service: ApiReporter.py, EmailReporter.py
Update documentation — add a docs page describing configuration
Update CHANGELOG.md in the repository root (not docs/) — add one line under Reporters in the beta section:
```
- Add <ReporterName>: <what CI system or output format it supports, one sentence>
```
Branch naming: use user/add-<reporter-name>-reporter

Más de este repositorio

mismo repositorio

pr-watch-fix-renovate

oxsecurity/megalinter

Run the pr-watch-fix loop in parallel across every open Renovate-bot PR, each in its own git worktree. Use to green-light or triage all dependency-update PRs at once.

2026-07-052.5k

fix-security-issue

oxsecurity/megalinter

Handle CVE/vulnerability reports from security linters (trivy, osv-scanner, etc.). Tries to upgrade first; ignores only when safe and justified; disables an unmaintained linter (with user confirmation) when a dangerous CVE has no fix.

2026-07-052.5k

pr-watch-fix

oxsecurity/megalinter

Watch the GitHub PR for the current branch, wait for CI to finish, and autonomously fix failing jobs by reading logs, editing sources, and pushing. Stops cleanly when stuck.

2026-07-052.5k

prepare-release

oxsecurity/megalinter

Prepare a MegaLinter release — update CHANGELOG (prune empty sections, collapse linter versions, backfill PR numbers), run the release build, push commit and tag, and guide GitHub release creation.

2026-06-282.5k

add-flavor

oxsecurity/megalinter

Add a new MegaLinter flavor (language-specific Docker image). Use when creating a new specialized Docker image variant.

2026-05-242.5k

add-linter

oxsecurity/megalinter

Guided workflow for adding a new linter to MegaLinter. Use when a contributor needs to add support for a new linting tool.

2026-05-242.5k

name	add-reporter
description	Add a new output reporter to MegaLinter. Use when adding support for a new CI system or output format.
allowed-tools	Read Grep Glob Edit Write
argument-hint	["reporter-name"]
model	sonnet

Guide through adding a new reporter named $ARGUMENTS to MegaLinter.

Steps:

Create the class in megalinter/reporters/<Name>Reporter.py extending megalinter.Reporter
Implement required methods:
- manage_activation() — check env var like <NAME>_REPORTER=true to enable/disable
- produce_report() — generate the report output
- Optionally: initialize(), add_report_item()
Register the reporter — check how existing reporters are discovered and loaded in megalinter/MegaLinter.py
Reference patterns from existing reporters:
- Simple output: ConsoleReporter.py, TapReporter.py
- CI integration: GithubCommentReporter.py, GitlabCommentReporter.py
- File output: JsonReporter.py, SarifReporter.py
- External service: ApiReporter.py, EmailReporter.py
Update documentation — add a docs page describing configuration
Update CHANGELOG.md in the repository root (not docs/) — add one line under Reporters in the beta section:
```
- Add <ReporterName>: <what CI system or output format it supports, one sentence>
```
Branch naming: use user/add-<reporter-name>-reporter