rename sparseCheckoutDir from StarterProject

[kadel]

What does this PR do?

rename sparseCheckoutDir to subDir and use it only in StarterProject

What issues does this PR fix or reference?

#128

Is your PR tested? Consider putting some instruction how to test your changes

Docs PR

[sleshchenko]

LGTM
@davidfestal please validate as well

[davidfestal]

OK for me.

Side question: I'm still wondering whether we should keep both the git and github project source types (that until now have the same structure).
Do we want to keep both for 2.0.0 or only keep git for now, and add the github union value in the future if really necessary ?

cc @l0rd

[kadel]

Do we want to keep both for 2.0.0 or only keep git for now, and add the github union value in the future if really necessary ?

This also crossed my mind. I would actually prefer removing github for now. We can re-introduce it later once there are some extra github features that this can use.

[sunix]

Sorry just been throught this one. In Che, sparseCheckoutDir is doing a git sparsecheckout. There is no confusion.
What it also do is keep the git directory so user can still git commit and so on.
In real life projects (not just testing samples), user would usually commit/push changes of a project.

[kadel]

Sorry just been throught this one. In Che, sparseCheckoutDir is doing a git sparsecheckout. There is no confusion.
What it also do is keep the git directory so user can still git commit and so on.
In real life projects (not just testing samples), user would usually commit/push changes of a project.

In that case, we could keep sparseCheckoutDir in project (and do proper sparse checkout) and in StarterProject use subDir.

In this case, it might make sense to make sparseCheckoutDir a list to allow specify multiple dirs to checkout.

[sunix]

In that case, we could keep sparseCheckoutDir in project (and do proper sparse checkout) and in StarterProject use subDir.

In this case, it might make sense to make sparseCheckoutDir a list to allow specify multiple dirs to checkout.

+1

[kadel]

updated,
@sunix @davidfestal please let me know if this works for you.

[amisevsk]

Looks fine in general but I'm still not clear on the distinction between sparseCheckoutDirs and subDir. At first glance, it looks like we have similar functionality with two different names.

Re-read the discussion; subPath = "grab only this directory" and sparseCheckout = git clone the whole project but do a sparse checkout. If so, that makes sense.

[sunix]

hey @kadel,
We had that use case: several projects in the same git repo. For instance 1 maven project in one sub path and 1 nodejs project in another sub path. For che, that was what one of the proposal: eclipse-che/che#15347
Let me know if this is the purpose of subDir. But if it is the case, it should be able to take multiple directories.

[davidfestal]

@kadel didn't you need that before the ODO release (since it would be a breaking change) ? Is there a reason it hasn't been merged ?

[kadel]

@kadel didn't you need that before the ODO release (since it would be a breaking change) ? Is there a reason it hasn't been merged ?

We worked around this in odo by removing sparceChecoutDir from all devfiles used by odo.

[kadel]

Re-read the discussion; subPath = "grab only this directory" and sparseCheckout = git clone the whole project but do a sparse checkout. If so, that makes sense.

yes, but with one important distinction.

• subPath is only for starterProject
• sparseCheckout is only for "main" project

subPath is not there for project, because it doesn't make sense. You can't do what subPath is doing ("grab only this directory") and end up with valid git repo.
sparseCheckout is not there for starterProject because we don't need it it wouldn't make much sense to do sparseCheckout for starterProject. For starterProject we want to just grab a specific directory not to do sparse checkout.