search

ljharb / repo-report

CLI to list all repos a user has access to, and report on their configuration in aggregate.
MIT License
24 stars 11 forks source link

Add Example Usage for JSON Output #70

Open dealako opened 2 years ago

dealako commented 2 years ago

Summary

Add Example Usage for JSON Output

Background

Provide an example on the main readme page illustrating how to generate an output report in JSON format.

Tasks

  1. Add example command line usage showing how to generate a JSON report
  2. (Optional) Provide a sample (sanitized) JSON report and store it in this repository (allows consumers to see a working example report)

Acceptance Criteria

  1. Example usage displayed on the main readme page.
  2. (optional) users can view publically accessible example JSON report
ljharb commented 2 years ago

Related: #68.

ljharb commented 2 years ago

Part of this issue should definitely be to add --json support, so you can repo-report --json > report.json.

abdumamdouh commented 2 years ago

@ljharb does this one still needs work or it's already done? if not can you assign it to me and @KhatiaIvanova

ljharb commented 2 years ago

It definitely still needs work :-)

ljharb commented 2 years ago

(I can't assign @KhatiaIvanova until they've commented on the issue)

KhatiaIvanova commented 2 years ago

@ljharb assign this issue to me as well