Mirror examples to separate repo about garden HOT 8 CLOSED

Would be nice to be able to git clone the examples separately though.

from garden.

Actually, we may want to keep them in the same repo if we go for #171 ?

from garden.

There's actually already an examples repo: https://github.com/garden-io/garden-examples

Wasn't the plan to maintain those examples separately and have other examples within the project that would function more as integration test?

from garden.

Yeah, I just kept the issue open (also because of the question above, which was just a thought) because we still have the examples in this repo. We should at least move them to the test/integ directory then to be sure not to cause confusion, and maybe just fold the features we want to integration test into a single project.

One issue with having the examples in a separate repo, is that we don't run any tests there, and don't pin the examples to a particular version of garden-cli. I've already seen cases where the examples have broken, and if we want to keep them separate we need to add some setup to automatically test them. Otherwise they'll inevitably drift, especially as our APIs are still changing fairly often.

from garden.

I propose we should keep the examples in the main repo, and then have them mirrored to a separate examples repo.

This way it's easier for us to commit changes to the code functionality and the respective adjustments to the examples in one single PR, for example, but we still have a separate and much lighter/smaller repo of examples only that we can use for didactic reasons.

Thoughts?

from garden.

Ellen and I talked about this earlier — just to clarify, mirroring = running a script that automatically updates the examples repo with changes to example projects in the main repo.

That way, example projects are still maintained/developed as part of the main dev/test/release workflows.

from garden.

Good idea! We could rig that up via Github hooks on master.

from garden.

I'm going to close this one since we have some other thoughts on how to maintain the examples as well, e.g. as submodules in the main project.

from garden.