Sync: subtree sync needs documentation

[corneliusweig]

Information

PR #1813 introduced the triple-star syntax for the sync map:

sync:
  'foo/***/*.js': /usr/src/app/

Its purpose is to recreate the directory structure under foo at the destination (see also #1807).

This feature needs some documentation. But where should it be documented?

EDIT The syntax may be changed. See #1844 and #1847.

[balopat]

well - the best place would be https://skaffold.dev/docs/how-tos/filesync/ but it's lacking a bit of documentation still :)

[balopat]

Also, I'm not fully convinced about triple star just yet...it's so non-standard...not that globs have any kind of standard (especially with docker's lack of ability to do preserved subtrees moby/moby#15858), but I feel like we are adding to the confusion with triple star.

[corneliusweig]

Should be put on hold until #1844 is settled.

[tejal29]

@balopat dont' worry @corneliusweig is taking that in to consideration in the design proposal something we can discuss later.

[tejal29]

Sorry, closed by accident

[gaetansnl]

Is there a way to sync subtrees with v0.25.0 ?

[corneliusweig]

Is there a way to sync subtrees with v0.25.0 ?

@pulse14 Yes, as of v0.25.0 with current master build you can do for example

sync:
  'src/***/*.py': dest/

This will sync all py-files below src and recreate the folder structure below src at dest. The syntax might change in future.

[evanpipta]

@corneliusweig That syntax does not work for me in v0.25.0, the files are all copied to the root of the dest folder without the folder structure preserved. Is there a separate issue open for this?

[gaetansnl]

I agree. I have 'packages/server/***/*.js': ./. The container workdir is /app/packages/server/.
When I edit packages/server/src/index.js it syncs it to /app/packages/server/index.js.
When I edit packages/server/src/somefolder/somefile.js it triggers a rebuild.
(I'm on windows)

[evanpipta]

@pulse14 @corneliusweig Nevermind, I see that the pull request to add *** was only merged after v0.25.0 was released. Maybe update your comment to say that you will be able to do that in the next release.

[corneliusweig]

@747823 🤦‍♂️ you are right, sorry for that confusion!

[casret]

I'm really curious about what the use case is for the current way ** works? I just don't see when you would want to flatten out a directory like that.

[corneliusweig]

@casret As discussed in #1844 the flattening will most likely be fixed with some other sync improvements 😉

[corneliusweig]

Superseded by #1994