Facilitate template update [WIP]

bird-house / cookiecutter-birdhouse

Cookiecutter template for Birdhouse PyWPS birds.

http://cookiecutter-birdhouse.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

3 stars 4 forks source link

Facilitate template update [WIP] #79

Closed huard closed 4 years ago

huard commented 4 years ago

Add update_from_cc.py script
Replace jinja timestamps by cookiecutter._timestamp

TODO:

Add instructions
Test

Fixes #61

huard commented 4 years ago

Maybe another option would be https://scaraplate.readthedocs.io/en/latest/

cehbrecht commented 4 years ago

@huard looks good. Thanks for adding this. Feel free to merge.

cehbrecht commented 4 years ago

@huard is it ready to merge?

huard commented 4 years ago

I was waiting for some feedback by @davidcaron who planned to test it with Finch.

davidcaron commented 4 years ago

Yes, I'll try it right now.

huard commented 4 years ago

@davidcaron Would you recommend defining a template branch that would track the cookiecutter template ?

davidcaron commented 4 years ago

@davidcaron Would you recommend defining a template branch that would track the cookiecutter template ?

I think this is a good idea, but when I get some time, I'll check out scaraplate like you mentioned or https://github.com/timothycrosley/cruft/

cehbrecht commented 4 years ago

I have used cruft to update hummingbird ... and it worked. There are some merge conflicts I had to solve: https://github.com/bird-house/hummingbird/pull/35

Zeitsperre commented 4 years ago

@cehbrecht I just discovered cruft the other day. Is it efficient/easy to work with?

cehbrecht commented 4 years ago

I find cruft easy to work with. I have tried now also scaraplate. That one looks more advanced. Currently I would favor cruft ... just a feeling.

@huard @davidcaron Would you like to update this PR to use one of these tools?

huard commented 4 years ago

Yes, it looks easier that what I came up with. I suggest we open a new similar PR using cruft.

tlvu commented 4 years ago

Found another cookiecutter updater: https://pypi.org/project/cookiecutter-project-upgrader/.

Clearly keeping projects up-to-date with the original cookiecutter template is a painful and popular topic.

Not clear which of the 3 tools we should go with yet, but here are my selection criteria:

simple to setup and use
handle merge conflict well for divergence between the original template and the instantiated template

We could help the merge conflict part by refactoring the template to split generic "lines" out to separate file(s). By having a clear physical boundary, we will be encouraged to write more generic "implementation" which will prevent merge conflicts down the lines.

huard commented 4 years ago

@tlvu This PR can probably be closed and redone from scratch using one package.

tlvu commented 4 years ago

Close this PR unmerged since it has been replaced by PR https://github.com/bird-house/cookiecutter-birdhouse/pull/85