Usage (Copier): specify git ref

NLeSC / python-template

Netherlands eScience Center Python Template

https://research-software-directory.org/software/nlesc-python-template

Apache License 2.0

186 stars 76 forks source link

Usage (Copier): specify git ref #413

Open egpbos opened 2 months ago

egpbos commented 2 months ago

See https://github.com/NLeSC/python-template/commit/ce6dd062f24cd5654a1d4367bfb7929a8d8850f3: in Copier, if you want the most recent version of the template, you must specify so, otherwise it will by default search the git history for the latest tagged release.

So when #399 is merged, we should mention this in the README usage instructions. Also, we may want to release more often so that users that don't specify HEAD still get a recent version.

abelsiqueira commented 2 months ago

I don't think we should encourage using main, so I wouldn't add the instructions. I would focus on releasing often instead.

sjvrijn commented 2 months ago

We should at least include it in developer instructions for testing locally

abelsiqueira commented 2 months ago

Agree. I'm actually working on that rn for Bestie

fdiblen commented 2 months ago

related to #412

egpbos commented 1 month ago

Just for context: this issue was discovered when testing the copier template dev version before it was released. Indeed, it fits better in the dev instructions. It was quite puzzling to see references to cookiecutter come up in error messages of the copier dev version, but the problem was that copier was referring back to 0.5.0 in the git history... which indeed was still the cookiecutter version :)