Skip to content

fix(watch): ignore .git at any depth inside the watched path #14363

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.

Sign up for GitHub

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

Open
htoyoda18 wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −1
Open

fix(watch): ignore .git at any depth inside the watched path #14363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/compose/watch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ func getWatchRules(config *types.DevelopConfig, service types.ServiceConfig) ([]
// add a hardcoded set of ignores on top of what came from .dockerignore
// some of this should likely be configurable (e.g. there could be cases
// where you want `.git` to be synced) but this is suitable for now
dotGitIgnore, err := watch.NewDockerPatternMatcher("/", []string{".git/"})
dotGitIgnore, err := watch.NewDockerPatternMatcher("/", []string{"**/.git"})
if err != nil {
return nil, err
}
Expand Down
28 changes: 28 additions & 0 deletions pkg/compose/watch_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,34 @@ func TestWatch_Sync(t *testing.T) {
})
}

// #14362: the .git ignore rule only matched /.git, not .git inside the watched path.
func TestWatchRules_IgnoreGitDirectoryAtAnyDepth(t *testing.T) {
root := t.TempDir()
rules, err := getWatchRules(&types.DevelopConfig{
Watch: []types.Trigger{{Path: root, Action: "rebuild"}},
}, types.ServiceConfig{Name: "test"})
assert.NilError(t, err)
assert.Equal(t, len(rules), 1)

for _, tt := range []struct {
path string
ignored bool
}{
{path: ".git", ignored: true},
{path: ".git/index", ignored: true},
{path: ".git/objects/ab/cdef", ignored: true},
{path: "vendor/lib/.git/HEAD", ignored: true},
{path: "main.go", ignored: false},
{path: ".gitignore", ignored: false},
{path: ".github/workflows/ci.yml", ignored: false},
} {
t.Run(tt.path, func(t *testing.T) {
mapping := rules[0].Matches(watch.NewFileEvent(filepath.Join(root, filepath.FromSlash(tt.path))))
assert.Equal(t, mapping == nil, tt.ignored)
})
}
}

// A rebuild running in the background from an earlier batch must not be
// raced by a plain restart of the same service triggered by a later batch:
// the restart is folded into the scheduler instead — the stale run is
Expand Down