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

Deprecate --rules in favor of rule-patterns #287

Merged
merged 9 commits into from
Nov 29, 2021
Merged

Conversation

tarkatronic
Copy link
Contributor

@tarkatronic tarkatronic commented Nov 22, 2021

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

Fixes #256

What's new?

  • A new rule-patterns configuration option has been added to move the contents of rules files directly into the tartufo config file.
  • Using the old --rules option will now raise a DeprecationWarning.

tarkatronic and others added 7 commits November 19, 2021 13:25
Adjustments to make mypy and pytest happy.
There's really no reason for it to be a dict. This change makes it more
consistent with similar inputs and simplifies some corner cases. Note
the uniqueness test now is based on the actual pattern rather than the
name (reason), and we no longer warn about duplicates because you
can't overwrite a rule with one that does something different.
@tarkatronic tarkatronic added this to the Version 3.0 milestone Nov 22, 2021
@tarkatronic tarkatronic linked an issue Nov 22, 2021 that may be closed by this pull request
@tarkatronic
Copy link
Contributor Author

There was no good place to document a new configuration option like this, so I added it to the end of the configuration.rst. Given that I will be doing a bit of a reorganization of documentation, I think this makes the most sense, and I will make an effort to move other similar configuration options into this same space.

@tarkatronic tarkatronic marked this pull request as ready for review November 22, 2021 23:39
@tarkatronic tarkatronic requested a review from a team as a code owner November 22, 2021 23:39
Copy link
Contributor

@sushantmimani sushantmimani 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

@rbailey-godaddy rbailey-godaddy left a comment

Choose a reason for hiding this comment

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

LGTM!

@tarkatronic tarkatronic merged commit e3d4c4e into v3.x Nov 29, 2021
@tarkatronic tarkatronic deleted the rule-patterns branch November 29, 2021 17:19
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.

Deprecate --rules in favor of --rule-patterns
4 participants