Add `TODO` comments only for first-time generation

frequenz-floss / frequenz-repo-config-python

Frequenz repository setup tools and common configuration for Python

https://frequenz-floss.github.io/frequenz-repo-config-python/

MIT License

4 stars 7 forks source link

Add `TODO` comments only for first-time generation #186

Open llucax opened 10 months ago

llucax commented 10 months ago

What's needed?

We need to make upgrading to new templates easier, and one of the main pain points is having to remove all the TODOs that are added and re-added each time the templates are generated.

Proposed solution

Only emit TODO comments if we are generating a repo for the first time. We could detect that by looking at the replay file or if we are already at a git repo.

Use cases

Every template update.

Alternatives and workarounds

No response

Additional context

No response

cwasicki commented 10 months ago

llucax commented 10 months ago

Ah, damn, good catch, it is a duplicate indeed. Thanks!

llucax commented 10 months ago

I'm marking the other one as duplicate because I think in here I have a better solution, so it will be more helpful when I have to implement it.