Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add annotations import and annotations export commands #171

Merged
merged 17 commits into from
Apr 25, 2024
Merged

Conversation

bradlarsen
Copy link
Collaborator

@bradlarsen bradlarsen commented Apr 11, 2024

Nosey Parker supports 3 kinds of user-supplied annotations at present:

  • Comments associated with findings (the finding_comment table in the datastore)
  • Comments associated with matches (the match_comment table in the datastore)
  • Statuses (one of ${accept,reject}$) associated with matches (the match_status table in the datastore)

(Note that the open-source version of Nosey Parker provides no mechanisms at present for populating these annotations.)

This pull request adds two new commands to Nosey Parker:

  • The annotations export command dumps the annotations from a datastore into a JSON format
  • The annotations import command takes a JSON file of annotations and attempts to import them into a datastore

These commands are experimental and likely to change in the future.

@bradlarsen bradlarsen added enhancement New feature or request reporting Related to reporting of findings ux Related to the user experience, invocation, or CLI labels Apr 11, 2024
@bradlarsen bradlarsen marked this pull request as ready for review April 25, 2024 20:44
@bradlarsen bradlarsen merged commit 3eff74f into main Apr 25, 2024
10 checks passed
@bradlarsen bradlarsen deleted the annotations branch April 25, 2024 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request reporting Related to reporting of findings ux Related to the user experience, invocation, or CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant