Skip to content

Document report path resolution#148

Merged
fabian-barney merged 1 commit into
mainfrom
codex/125-document-report-paths
May 15, 2026
Merged

Document report path resolution#148
fabian-barney merged 1 commit into
mainfrom
codex/125-document-report-paths

Conversation

@fabian-barney
Copy link
Copy Markdown
Owner

Summary

  • Document the existing report path contract for --output and --junit-report in CLI help and README.
  • Clarify that relative report paths resolve from the analyzed project root, while absolute paths and normalized paths outside the root are honored.
  • Keep the existing behavior intact because callers and build plugins can intentionally target external artifact locations.

Classification

Valid as a documentation hardening issue. I am not restricting paths because that would be a compatibility change for an intentional filesystem-output contract; CI configurations should keep these values trusted.

Verification

  • mvn verify

Closes #125

Copilot AI review requested due to automatic review settings May 15, 2026 19:02
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only PR that clarifies how --output and --junit-report paths are resolved (relative to project root, absolute paths honored, .. traversal allowed), addressing issue #125 without changing behavior.

Changes:

  • Added a "Report paths" section to the CLI usage text in Main.usage().
  • Added matching guidance to the README.
  • Extended the help-output test to assert the new usage lines are present.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
core/src/main/java/media/barney/crap/core/Main.java Adds "Report paths" block to CLI help text.
README.md Documents the report path resolution contract.
core/src/test/java/media/barney/crap/core/MainTest.java Asserts new help text appears in stdout.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@fabian-barney fabian-barney merged commit 278279a into main May 15, 2026
11 checks passed
@fabian-barney fabian-barney deleted the codex/125-document-report-paths branch May 15, 2026 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Low] security: ReportPublisher honors '..' traversal and absolute paths for --output/--junit-report

2 participants