Skip to content

Document --licensefile-to-license-mappings with explicit path resolution behavior#354

Merged
sensslen merged 2 commits into
simon/fix-invalid-license-pathsfrom
copilot/update-documentation-command-line-argument
Dec 2, 2025
Merged

Document --licensefile-to-license-mappings with explicit path resolution behavior#354
sensslen merged 2 commits into
simon/fix-invalid-license-pathsfrom
copilot/update-documentation-command-line-argument

Conversation

Copy link
Copy Markdown

Copilot AI commented Dec 2, 2025

The --licensefile-to-license-mappings command line option lacked documentation. Users needed explicit guidance on path resolution semantics.

Changes

  • Added docs/licensefile-mappings-json.md: Documents JSON format and path resolution behavior. License file paths are resolved relative to the JSON file's directory, not the working directory.

  • Updated README.md:

    • Added option to command line arguments table
    • Added usage example with path resolution note

Example

Given a JSON file at /project/config/license-mappings.json:

{
  "licenses/MIT.txt": "MIT",
  "../external/Apache.txt": "Apache-2.0"
}

Paths resolve to:

  • licenses/MIT.txt/project/config/licenses/MIT.txt
  • ../external/Apache.txt/project/external/Apache.txt
Original prompt

Update documentation to include the newly added command line argument. Be sure to be explicit about how the path's need to be defined


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Dec 2, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: sensslen <3428860+sensslen@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Dec 2, 2025

Copilot AI changed the title [WIP] Update documentation to include command line argument details Document --licensefile-to-license-mappings with explicit path resolution behavior Dec 2, 2025
Copilot AI requested a review from sensslen December 2, 2025 22:40
@sensslen sensslen marked this pull request as ready for review December 2, 2025 22:54
@sensslen sensslen merged commit 86836c6 into simon/fix-invalid-license-paths Dec 2, 2025
3 checks passed
@sensslen sensslen deleted the copilot/update-documentation-command-line-argument branch December 2, 2025 22:54
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.

2 participants