Add a migration script #240
Conversation
github-actions
bot
added
part:cookiecutter
Signed-off-by: Leandro Lucarella <[email protected]>
Add a step to reset the migration script. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
migration-script
branch
from
d717965 to
b0d6ba5
Compare
llucax
added
part:tooling
| it directly. | ||
|
|
||
| ```sh | ||
| curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/{{ ref_name }}/cookiecutter/migrate.sh \ |
There was a problem hiding this comment.
why not call it version instead of ref_name? refname seems to be for some script or tool, not for the user guide text? :)
There was a problem hiding this comment.
This is a macro, it is expanded in the docs, the user never sees it.
| To run it, the simplest way is to fetch it from GitHub and run it directly: | ||
|
|
||
| ```console | ||
| curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh |
There was a problem hiding this comment.
Could we also provide something like python -m frequenz.repo-config.migrate v0.10.0 or so? Might be more accessible
There was a problem hiding this comment.
Yes, that's the end goal, I even created a repo label part:cli but the cli tool never came because of time issues. I prefer not to start now because I want to split this repo soon ™️ (to smaller libraries, like https://github.com/frequenz-floss/setuptools-betterproto/) and a repository for the cookiecutter templates. The migration tool should definitely live in the cookiecutter template repo, but other commands should live elsewhere (like the version calculation tools used by the CI).
So for now I preferred to go with something very simple, to see how it works and not to build a huge thing that will need to be teared apart soon.
Co-authored-by: daniel-zullo-frequenz <[email protected]> Signed-off-by: Leandro Lucarella <[email protected]>
llucax
dismissed stale reviews from daniel-zullo-frequenz and Marenz
via
4511f87
|
Enabling auto-merge, as the comments were optional and I think they are sort of addressed. |
|
Oh, it needs a new approval anyway. |
This might not be the most advanced approach, but it should be a good starting point to greatly improve the UX of the upgrade process.