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 a new "--scan-filename/--no-scan-filename" flag #259

Merged
merged 7 commits into from Nov 5, 2021

Conversation

sushantmimani
Copy link
Contributor

To help us get this pull request reviewed and merged quickly, please be sure to include the following items:

  • Tests (if applicable)
  • Documentation (if applicable)
  • Changelog entry
  • A full explanation here in the PR description of the work done

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Tests
  • Other

Backward Compatibility

Is this change backward compatible with the most recently released version? Does it introduce changes which might change the user experience in any way? Does it alter the API in any way?

  • Yes (backward compatible)
  • No (breaking changes)

Issue Linking

Closes #188

What's new?

  • This PR adds a new --scan-filename/--no-scan-filename flag which allows user to enable or disable file name scanning using Tartufo.

@tarkatronic
Copy link
Contributor

tarkatronic commented Nov 3, 2021

Thanks for adding this functionality @sushantmimani! As I look at this more, I really can't decide how this should behave; whether it should default to True, default to False, or just always be on. So I've created a discussion to hopefully get some user input on their preferences.

See the discussion here: #262

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to the changes noted here, what about scan-folder? Since this is a global option, we need to ensure that it will work across all scanner types.

tartufo/cli.py Outdated Show resolved Hide resolved
tartufo/cli.py Outdated Show resolved Hide resolved
Copy link
Contributor

@mayuriesha mayuriesha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little concerned that the tests didn't need to be updated for the scan-folder change 😅

Can we make sure that is for reals really working? Is there any kind of unit test we can do for that?

README.md Outdated Show resolved Hide resolved
sushantmimani and others added 2 commits November 4, 2021 15:19
Co-authored-by: Joey Wilhelm <tarkatronic@gmail.com>
Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it!

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.

Tartufo does not detect secrets in filenames (in the name of the files)
3 participants