Let conan config install walk the fs tree looking for a .conanignore#18170
Merged
franramirez688 merged 12 commits intoMay 7, 2025
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds functionality to have "conan config install" search up the file system for a .conanignore file, preventing unwanted files from being installed.
- Introduces tests to verify behavior when a .conanignore is present or absent.
- Implements a new helper function that walks the directory tree to locate a .conanignore file.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/integration/command/config_test.py | Added tests to validate that the .conanignore is correctly applied. |
| conan/internal/api/config/config_installer.py | Added the recursive lookup helper (_find_conaningore) and updated folder processing to use it. |
Comments suppressed due to low confidence (2)
test/integration/command/config_test.py:168
- [nitpick] The test function name 'test_config_install_conanignore_march_directories' appears to contain a typo. Consider renaming it to something like 'test_config_install_conanignore_match_directories' for clarity.
def test_config_install_conanignore_march_directories(has_conanignore, folder):
conan/internal/api/config/config_installer.py:131
- The function name '_find_conaningore' seems to be misspelled; consider renaming it to '_find_conanignore' to accurately reflect its purpose and align with established naming conventions.
def _find_conaningore(folder):
memsharded
reviewed
Apr 24, 2025
0ae8eb3 to
e0e1495
Compare
memsharded
approved these changes
Apr 29, 2025
memsharded
reviewed
Apr 29, 2025
franramirez688
approved these changes
May 5, 2025
Contributor
|
@AbrilRBS Besides the comment, there are conflicts pending 🙏 |
eab8cc9 to
399d27a
Compare
memsharded
reviewed
May 5, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug in the “conan config install” command by updating the file search logic so that a .conanignore file can be located by walking up the file system tree. Key changes include:
- Adding a new helper function (find_file_walk_up) to traverse parent directories.
- Refactoring tests in both unit and integration suites to verify the new upward search behavior.
- Updating the config installer to use the new helper function in determining the .conanignore file.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/unittests/paths/user_home_test.py | Refactored tests into classes and added tests for the new helper function. |
| test/integration/command/config_test.py | Added parametrized tests to validate the .conanignore behavior during config install. |
| conan/internal/paths.py | Introduced find_file_walk_up and updated get_conan_user_home to use it. |
| conan/internal/api/config/config_installer.py | Updated _process_folder to use find_file_walk_up for locating the .conanignore file. |
… the source_path path
…into ar/conanignore-walk-tree
AbrilRBS
commented
May 7, 2025
| with chdir(folder_conan_runs): | ||
| conan_home = get_conan_user_home() | ||
| assert _temp_folder == conan_home | ||
| class TestConanUserHome: |
Member
Author
There was a problem hiding this comment.
Same tests here, just moved to a class
memsharded
approved these changes
May 7, 2025
franramirez688
approved these changes
May 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog: Bugfix: Let
conan config installwalk the fs tree looking for a.conanignore.Docs: Omit
I was trying to install a specific command from conan-extensions and realized that the readme next to it was being installed too.
This PR is a draft because I'm not quite sure of the implications of walking the tree in all contexts where this could be called: