Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accommodate cookiecutter templates repository #146

Closed
eudesbarbosa opened this issue Dec 5, 2022 · 0 comments · Fixed by #170
Closed

Accommodate cookiecutter templates repository #146

eudesbarbosa opened this issue Dec 5, 2022 · 0 comments · Fixed by #170
Assignees

Comments

@eudesbarbosa
Copy link
Member

Background
We are planning to move ISA Tab cookiecutter templates to their own repository. Hence, we need to adjust the code to accommodate these changes.

Possible Solution
Add a submodule for the new repository - this way the templates are still a part of cubi-tk code. Disadvantage of the approach is that using --recurse-submodules is error-prone.
This change affects how we clone and update already cloned versions of the repo: i) the documentation should include git submodule instructions; and ii) it should reference a specific SHA in the target repo.

Alternative solutions

  1. Let cubi-tk clone the template repository and then call cookiecutter() on the subdirectories. It wouldn't require submodule, but future releases could suffer as we would be tracking another repository version in the source code.
  2. Create one repository per template and call cookiecutter() on the upstream template URLs directly - i.e., how it was "meant" to be used. The downside would be to track and maintain the 5+ loosely connected repositories.

Additional context
Related issue: #96

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants