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

Remove upward traversal logic for config discovery #479

Merged
merged 6 commits into from
Mar 30, 2023

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
    This PR removes the upward traversal logic for configuration discovery in Tartufo. Tartufo will no longer look for configuration files in unspecified parent directories.

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)
    This is a breaking change for users who were relying on upward traversal for configuration discovery

Issue Linking

Fixes #475

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.

One documentation cleanup/clarification point only. Can't argue with the logic, yay!

docs/source/configuration.rst Show resolved Hide resolved
docs/source/configuration.rst Show resolved Hide resolved
Copy link

@jsimmons1-godaddy jsimmons1-godaddy left a comment

Choose a reason for hiding this comment

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

Looks good to me, for what it's worth. Thanks for making these changes

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.

Sorry, but a little more wordsmithing....

docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
sushantmimani and others added 2 commits March 30, 2023 08:46
Co-authored-by: Scott Bailey <72747501+rbailey-godaddy@users.noreply.github.com>
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.

I saw a missing space you can add and then I'm good to go!

files on the command line. Each file is located and processed in order. When
conflicting directives are provided in different files, the value in the last
files on the command line. Paths specified using --config are interpreted
relative to the current working directory.Each file is located and processed in order.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
relative to the current working directory.Each file is located and processed in order.
relative to the current working directory. Each file is located and processed in order.

@sushantmimani sushantmimani merged commit 814d1b8 into godaddy:main Mar 30, 2023
@sushantmimani sushantmimani deleted the remove-upward-traversal branch March 30, 2023 18:58
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.

Do not traverse directories with --config
4 participants