Walkthrough

This PR makes dfetch ignore VCS-ignored files when detecting local changes: it adds per-repo ignored-files helpers, threads ignore lists through check/update commands, updates VCS change detection to respect ignore lists, and updates tests and BDD steps accordingly.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant CLI as dfetch CLI
    participant Cmd as Command (update/check)
    participant Common as files_to_ignore()
    participant Repo as Repo (Git/SVN)
    participant VCS as VCS layer
    participant FS as Local FS

    CLI->>Cmd: run update/check [--force]
    Cmd->>Common: files_to_ignore(project.destination)
    Common->>Repo: repo.ignored_files(project.destination)
    Repo->>FS: query ignored files (git/svn)
    FS-->>Repo: ignored files list
    Repo-->>Common: ignored files
    Common-->>Cmd: files_to_ignore list

    Cmd->>VCS: update/check(force, files_to_ignore)
    VCS->>VCS: _are_there_local_changes(files_to_ignore)
    VCS->>FS: compute current tree hash (exclude files_to_ignore)
    FS-->>VCS: computed hash

    alt local changes detected and not forced
        VCS-->>Cmd: report skipped (local changes)
        Cmd-->>CLI: skipped message
    else no local changes or forced
        VCS->>Repo: fetch/update remote
        Repo-->>VCS: fetched
        VCS-->>Cmd: updated
        Cmd-->>CLI: success message
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• New files not part of dfetch diff generated patch #888: Similar work propagating ignore-list handling into VCS/diff/update flows and touching Git/SVN ignored-file logic.

Poem

🐰 I hopped through .git and svn with care,

Skipped the crumbs they hide, left them there,
Updates now mind what ignores say,
Force may stomp if you shout "OK!",
A joyful nibble, safe and fair.

Pre-merge checks and finishing touches

• 📝 Generate docstrings

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Reviewing files that changed from the base of the PR and between 63d8e76 and f6978d1.

• CHANGELOG.rst
• dfetch/commands/check.py
• dfetch/commands/common.py
• dfetch/commands/diff.py
• dfetch/commands/update.py
• dfetch/manifest/project.py
• dfetch/project/svn.py
• dfetch/project/vcs.py
• dfetch/vcs/git.py
• doc/conf.py
• features/check-git-repo.feature
• features/check-svn-repo.feature
• features/guard-against-overwriting-git.feature
• features/guard-against-overwriting-svn.feature
• features/guard-against-overwriting.feature
• features/steps/generic_steps.py
• features/steps/git_steps.py
• features/steps/svn_steps.py
• pyproject.toml
• tests/test_update.py
• tests/test_vcs.py

• features/guard-against-overwriting.feature
• features/steps/git_steps.py

• dfetch/manifest/project.py

• CHANGELOG.rst
• dfetch/vcs/git.py
• dfetch/project/svn.py
• tests/test_vcs.py
• features/guard-against-overwriting-svn.feature
• features/guard-against-overwriting-git.feature
• dfetch/commands/common.py

Learnt from: spoorcc
Repo: dfetch-org/dfetch PR: 895
File: dfetch/commands/check.py:133-142
Timestamp: 2025-12-31T10:55:20.972Z
Learning: In dfetch, when determining ignored files for a project, the VCS detection should use the superproject's VCS type (where the manifest is located), not the fetched project's VCS type. The ignored files are then queried from the project's destination path using the superproject's VCS system.

Learnt from: spoorcc
Repo: dfetch-org/dfetch PR: 895
File: dfetch/commands/check.py:133-142
Timestamp: 2025-12-31T10:55:20.972Z
Learning: In dfetch, when determining ignored files for a project, the VCS detection should use the superproject's VCS type (where the manifest is located), not the fetched project's VCS type. The ignored files are then queried from the project's destination path using the superproject's VCS system.

Applied to files:

• features/check-git-repo.feature
• features/check-svn-repo.feature
• dfetch/commands/update.py
• dfetch/commands/check.py
• dfetch/project/vcs.py

dfetch/commands/common.py (1)

• files_to_ignore (71-79)

dfetch/commands/common.py (1)

• files_to_ignore (71-79)

dfetch/project/vcs.py (1)

• update (95-146)

dfetch/commands/common.py (1)

• files_to_ignore (71-79)

dfetch/project/vcs.py (1)

• check_for_update (159-193)

dfetch/manifest/project.py (1)

• destination (405-407)

dfetch/commands/common.py (1)

• files_to_ignore (71-79)

dfetch/project/abstract_check_reporter.py (1)

• AbstractCheckReporter (9-91)

dfetch/util/util.py (1)

• in_directory (66-75)

• GitHub Check: Codacy Static Code Analysis
• GitHub Check: test (windows-latest, 3.9)
• GitHub Check: test (windows-latest, 3.12)
• GitHub Check: test (windows-latest, 3.14)
• GitHub Check: test (windows-latest, 3.10)
• GitHub Check: test (windows-latest, 3.13)
• GitHub Check: test (windows-latest, 3.11)
• GitHub Check: test (macos-latest, 3.11)
• GitHub Check: test (macos-latest, 3.10)
• GitHub Check: test-cygwin
• GitHub Check: test
• GitHub Check: build (windows-latest)
• GitHub Check: build (macos-latest)
• GitHub Check: build (ubuntu-latest)
• GitHub Check: DevContainer Build & Test

dfetch/commands/diff.py (1)

22-30: LGTM! Documentation presentation improved.

The tabbed interface for Git and SVN scenarios enhances the documentation by allowing users to view relevant examples side-by-side. This is a purely presentational improvement with no functional changes.

Also applies to: 40-52

features/steps/svn_steps.py (1)

93-96: LGTM! Test step follows established patterns.

The new step definition for adding SVN tags reuses the existing create_tag helper and follows the same pattern as other step definitions in this file.

tests/test_update.py (1)

68-68: LGTM! Test updated for new API.

The test correctly verifies that the update method is called with the new files_to_ignore parameter, reflecting the API changes introduced in this PR.

features/check-svn-repo.feature (1)

162-180: LGTM! Scenario validates ignore functionality.

This scenario properly tests that SVN-ignored files don't affect the up-to-date status of a project, which is the core fix for issue #350.

features/check-git-repo.feature (1)

140-157: LGTM! Git scenario mirrors SVN behavior.

This scenario validates that Git-ignored files don't affect project status, paralleling the SVN scenario and ensuring consistent behavior across VCS types.

dfetch/project/vcs.py (3)

95-112: LGTM! Clean API extension with proper defaults.

The update method now accepts an optional files_to_ignore parameter that defaults to an empty list, maintaining backward compatibility while enabling the new ignore functionality. The parameter is properly propagated to _are_there_local_changes.

---

159-187: LGTM! Consistent propagation through check flow.

The check_for_update method correctly accepts and propagates the files_to_ignore parameter to the local changes detection, ensuring ignored files don't trigger false positives during checks.

---

349-361: LGTM! Correct implementation of ignore logic.

The _are_there_local_changes method properly incorporates files_to_ignore into the skiplist when computing the directory hash, ensuring ignored files are excluded from local change detection.

dfetch/commands/update.py (2)

8-16: LGTM! Documentation presentation improved.

The tabbed interface provides clearer side-by-side documentation for Git and SVN workflows.

---

40-40: LGTM! Proper integration of ignore functionality.

The files_to_ignore function is correctly imported and called with project.destination to determine which files can be ignored during updates. Based on learnings, this correctly uses the superproject's VCS type to query ignored files from the project's destination path.

Also applies to: 89-92

dfetch/commands/check.py (2)

8-16: LGTM! Documentation presentation improved.

The tabbed interface enhances documentation clarity by presenting Git and SVN scenarios side-by-side.

---

37-37: LGTM! Consistent ignore functionality integration.

The check command mirrors the update command's approach: importing files_to_ignore and calling it with project.destination to obtain per-project ignore lists. This ensures consistent behavior across check and update operations. Based on learnings, this correctly uses the superproject's VCS type to query ignored files from the project's destination path.

Also applies to: 101-103

features/steps/generic_steps.py (3)

124-132: LGTM!

The implementation is clean and follows the same pattern as existing file utilities in this module. Using UTF-8 encoding is consistent with the rest of the codebase.

---

157-160: LGTM!

The step definition follows the established pattern in this file. Using only @given is appropriate if this step is intended solely for test setup/precondition contexts.

---

205-209: LGTM!

Adding the @given decorator alongside the existing @when allows this step to be used in both setup and action contexts, which is a common and useful Behave pattern consistent with other dual-decorator steps in this file (e.g., lines 167-168, 188-189).

doc/conf.py (1)

42-42: LGTM! Extension properly configured.

The sphinx_tabs.tabs extension is correctly added to enable tabbed content in documentation, and the corresponding dependency is declared in pyproject.toml.

pyproject.toml (1)

100-100: Version is current and secure.

The sphinx-tabs==3.4.7 dependency is the latest available version on PyPI and is actively used in the documentation via the sphinx_tabs.tabs extension in doc/conf.py. No known security vulnerabilities exist for this version.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

• X
• Mastodon
• Reddit
• LinkedIn

Comment @coderabbitai help to get the list of available commands and usage tips.