Document report path resolution#148
Merged
Merged
Conversation
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--outputand--junit-reportin CLI help and README.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 verifyCloses #125