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

Improve scan --github-org=ORG UX #212

Merged
merged 3 commits into from
Aug 13, 2024
Merged

Improve scan --github-org=ORG UX #212

merged 3 commits into from
Aug 13, 2024

Conversation

bradlarsen
Copy link
Collaborator

No description provided.

@bradlarsen bradlarsen added enhancement New feature or request ux Related to the user experience, invocation, or CLI labels Aug 12, 2024
@bradlarsen bradlarsen marked this pull request as ready for review August 12, 2024 21:18
@bradlarsen bradlarsen marked this pull request as draft August 12, 2024 21:36
@bradlarsen
Copy link
Collaborator Author

I need to think about the behavior of this a bit more. Consistent path handling in a way that's portable across environments is a bit tricky.

@bradlarsen
Copy link
Collaborator Author

My thoughts on path handling:

Paths that are recorded to the datastore by Nosey Parker should ideally not be locked to the particular machine that performed the scanning.

The motivating use case: someone scans on one machine, and then is able to meaningfully review the findings on another machine, without having to manually translate paths. (This scenario happens more commonly when scanning is done using the Docker container, and then review / triage is done outside the container.)

To avoid tying the paths recorded in the datastore to the scanning machine, this means:

  1. Absolute paths that reference the inputs files should be avoided. If the user specifies relative paths on the command line, those should be used for recording in the datastore, rather than canonicalizing them. (This PR fixes one place where absolute paths were being used — scan --github-org=ORG.)

  2. (Unsure) Relative paths for inputs should be made relative to the datastore used for scanning?

Anyway, this can be revisited. For now, I'll merge these fixes.

@bradlarsen bradlarsen marked this pull request as ready for review August 13, 2024 16:07
@bradlarsen bradlarsen merged commit e0c397c into main Aug 13, 2024
12 checks passed
@bradlarsen bradlarsen deleted the github-org-tweaks branch August 13, 2024 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ux Related to the user experience, invocation, or CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant