Add a migrate package command

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start with the existing package command entry points and the upgrade guidance at bobtemplatesplone.readthedocs.io/upgrade-packages.html. The migration should update all configure.zcml files, add the required placeholder line, and verify either bobtemplates.cfg or the preferred pyproject.toml configuration exists. Done means existing packages can be migrated compatibly with plonecli/botemplates.plone.

Written by the indexing model from the issue text.

Description

To make it easier to migrate existing packages, to be compatible with plonecli/botemplates.plone, we need a migrate command. This command should update existing files and add needed placeholders.

  1. adding placeholder line into all configure.zcml files
  2. checking that either bobtemplates.cfg or pyproject.toml with plonecli/bobtemplate.plone settings exists, the later is the preferred solution for future package structure.

see https://bobtemplatesplone.readthedocs.io/upgrade-packages.html for details

Dominant language
Python
Stars
20
Forks
12
No merged PRs in 30d

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.

More from plone/plonecli

All issues in plone/plonecli

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.