Add plonecli/bobtemplates.plone compatible markers and configuration #63

erral · 2024-10-05T07:46:48Z

Adding these markers, one can use plonecli to add features to the backend addon.

This needs plone/bobtemplates.plone#568 to correctly work.

And also some documentation that I will be adding in the backend package's README file, because it needs to run plonecli with the custom configuration file provided here.

I think that plonecli/bobtemplates.plone is mature enough and saves a lot of time when adding features to backend, and it will be definelty useful in a project/add-on generator like this.

stevepiercy

Thanks for the docs!

...rc/{{ cookiecutter.__package_namespace }}/{{ cookiecutter.__package_name }}/permissions.zcml

...r.__package_namespace }}/{{ cookiecutter.__package_name }}/profiles/default/controlpanel.xml

...ecutter.__package_namespace }}/{{ cookiecutter.__package_name }}/vocabularies/configure.zcml

backend_addon/{{ cookiecutter.__folder_name }}/README.md

erral · 2024-10-05T14:48:59Z

Thanks for the docs!

Thanks for your review!!!

davisagli

Nice idea.

davisagli · 2024-10-05T16:09:05Z

backend_addon/{{ cookiecutter.__folder_name }}/bobtemplate.cfg

+version = 6.0.13
+template = plone_addon
+git_init = True
+python = python3


This is not necessarily a blocker, but would it be possible to add support for mr.bob/bobtemplates.plone to get their settings from pyproject.toml, so that we don't need more config files?

I guess that there's no problem with that. Would you mind adding an issue in bobtemplates.plone repo?

plone/bobtemplates.plone#569

backend_addon/{{ cookiecutter.__folder_name }}/README.md

erral · 2024-10-05T16:23:01Z

@davisagli I have rephrased the existing example, added a couple more and linked the README file where all subtemplates are listed.

stevepiercy

Just two suggestions left to resolve.

I updated the revisions that @erral put in, with commit ff5ae21 so they need another pair of eyes.

stevepiercy · 2024-10-08T23:20:27Z

backend_addon/{{ cookiecutter.__folder_name }}/README.md

+This package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).
+These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`.
+
+To use them, you need to use `bobtemplates.plone` version X.X.X or later, and run the following command.


We need to update the version number here. The current version of bobtemplates.plone is 6.3.3. Is this feature already in a release or a future one?

No yet, there's a pending PR on bobtemplates.plone to be able to use these changes.

@erral Any update?

The PR was merged early this week, but the release is still missing.

release is out ;)

backend_addon/{{ cookiecutter.__folder_name }}/README.md

@erral

* Add more references. See plone/cookieplone-templates#63 * Incorporate @erral's suggestions, I think

erral · 2024-10-10T09:44:00Z

Would it be useful to add a make add XXXX command to internally call plonecli and this way ease the procedure? We can call plonecli with pipx run or uv run plonecli so it would be quite straightforward 🤔

MrTango

great

MrTango · 2024-11-05T10:53:49Z

Would it be useful to add a make add XXXX command to internally call plonecli and this way ease the procedure? We can call plonecli with pipx run or uv run plonecli so it would be quite straightforward 🤔

maybe calling mr.bob directly is a better idea, but both work. The only thing is, plonecli is already a wrapper around bobtemplates.plone, so for a Makefile i would do the same as plonecli does, but call the templates directly.
On the other hand, does it really make sense to use make for this? As e lose some functionality, like autocomplete of templates.

erral · 2024-11-05T11:11:05Z

Would it be useful to add a make add XXXX command to internally call plonecli and this way ease the procedure? We can call plonecli with pipx run or uv run plonecli so it would be quite straightforward 🤔

maybe calling mr.bob directly is a better idea, but both work. The only thing is, plonecli is already a wrapper around bobtemplates.plone, so for a Makefile i would do the same as plonecli does, but call the templates directly. On the other hand, does it really make sense to use make for this? As e lose some functionality, like autocomplete of templates.

The point was trying to use the same mechanism that this template provides: use make for everything.

But I am open to discuss it :)

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/permissions.zcml Co-authored-by: Steve Piercy <web@stevepiercy.com>

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/profiles/default/controlpanel.xml Co-authored-by: Steve Piercy <web@stevepiercy.com>

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/vocabularies/configure.zcml Co-authored-by: Steve Piercy <web@stevepiercy.com>

Co-authored-by: Steve Piercy <web@stevepiercy.com>

erral requested a review from ericof as a code owner October 5, 2024 07:46

erral mentioned this pull request Oct 5, 2024

allow overriding package.dottedname through a configuration file plone/bobtemplates.plone#568

Merged

erral requested a review from MrTango October 5, 2024 07:47

stevepiercy requested changes Oct 5, 2024

View reviewed changes

davisagli reviewed Oct 5, 2024

View reviewed changes

stevepiercy added a commit to plone/documentation that referenced this pull request Oct 8, 2024

Add more references. See plone/cookieplone-templates#63

6ad0a86

stevepiercy mentioned this pull request Oct 8, 2024

Add more mr.bob, bobtemplates.plone, plonecli references plone/documentation#1734

Merged

stevepiercy requested changes Oct 8, 2024

View reviewed changes

stevepiercy added a commit to plone/documentation that referenced this pull request Oct 9, 2024

Add more mr.bob, bobtemplates.plone, plonecli references (#1734)

2738abc

* Add more references. See plone/cookieplone-templates#63 * Incorporate @erral's suggestions, I think

erral requested a review from sneridagh as a code owner October 10, 2024 13:07

MrTango approved these changes Nov 5, 2024

View reviewed changes

erral and others added 14 commits November 13, 2024 21:14

add a mr.bob config file to be able to use plonecli commands here

50f47f0

add mr.bob/bobtemplates.plone markers to allow using plonecli

93868a7

add more markers

37c12e4

more markers

ef8b0a7

add documentation on how to use plonecli

1b58184

Update backend_addon/{{ cookiecutter.__folder_name }}/src/{{ cookiecu…

b237676

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/permissions.zcml Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/src/{{ cookiecu…

bd9c25b

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/profiles/default/controlpanel.xml Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/src/{{ cookiecu…

1ebf292

…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/vocabularies/configure.zcml Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/README.md

0f0d91c

Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/README.md

03ef7db

Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/README.md

ec3e0dd

Co-authored-by: Steve Piercy <web@stevepiercy.com>

Update backend_addon/{{ cookiecutter.__folder_name }}/README.md

dbe77c0

Co-authored-by: Steve Piercy <web@stevepiercy.com>

add examples of how to add different features

24161d1

Update backend_addon/{{ cookiecutter.__folder_name }}/README.md

8ef158b

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy and others added 3 commits November 13, 2024 21:15

Revise @erral's updates for grammar and additional link

7897925

add a make command to call plonecli

68f1990

use pipx to run plonecli

daf03c0

erral force-pushed the erral-allow-using-plonecli branch from 949dbb0 to daf03c0 Compare November 13, 2024 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add plonecli/bobtemplates.plone compatible markers and configuration #63

Add plonecli/bobtemplates.plone compatible markers and configuration #63

erral commented Oct 5, 2024 •

edited

Loading

stevepiercy left a comment

erral commented Oct 5, 2024

davisagli left a comment

davisagli Oct 5, 2024

erral Oct 5, 2024

davisagli Oct 5, 2024

erral commented Oct 5, 2024 •

edited

Loading

stevepiercy left a comment

stevepiercy Oct 8, 2024

erral Oct 9, 2024

davisagli Oct 30, 2024

erral Oct 31, 2024 •

edited

Loading

MrTango Nov 5, 2024

erral commented Oct 10, 2024

MrTango left a comment

MrTango commented Nov 5, 2024

erral commented Nov 5, 2024

Add plonecli/bobtemplates.plone compatible markers and configuration #63

Are you sure you want to change the base?

Add plonecli/bobtemplates.plone compatible markers and configuration #63

Conversation

erral commented Oct 5, 2024 • edited Loading

stevepiercy left a comment

Choose a reason for hiding this comment

erral commented Oct 5, 2024

davisagli left a comment

Choose a reason for hiding this comment

davisagli Oct 5, 2024

Choose a reason for hiding this comment

erral Oct 5, 2024

Choose a reason for hiding this comment

davisagli Oct 5, 2024

Choose a reason for hiding this comment

erral commented Oct 5, 2024 • edited Loading

stevepiercy left a comment

Choose a reason for hiding this comment

stevepiercy Oct 8, 2024

Choose a reason for hiding this comment

erral Oct 9, 2024

Choose a reason for hiding this comment

davisagli Oct 30, 2024

Choose a reason for hiding this comment

erral Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

MrTango Nov 5, 2024

Choose a reason for hiding this comment

erral commented Oct 10, 2024

MrTango left a comment

Choose a reason for hiding this comment

MrTango commented Nov 5, 2024

erral commented Nov 5, 2024

erral commented Oct 5, 2024 •

edited

Loading

erral commented Oct 5, 2024 •

edited

Loading

erral Oct 31, 2024 •

edited

Loading