plone / plone/plonecli

Make it possible to import common upgrade steps

Open
#60 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

04 type: enhancement
Dominant language
Python
Stars
20
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Description

It would be useful for developers to be able to quickly import common upgrade steps.
I propose that a utils.py file be generated when upgrade_step is added.
The utils.py would include common upgrade steps (similar to the utilities that are provided by ftw.upgrade).
A developer could then choose the proper utilities to run by importing the appropriate steps.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the upgrade_step command and how generated files are created. Compare the proposed utils.py contents with the utilities provided by ftw.upgrade, then define which common steps should be importable and how generation should behave. Done means adding upgrade_step generates a usable utils.py with the intended common upgrade steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.