Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

erral
Copy link
Member

@erral erral commented Oct 5, 2024

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.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the docs!

@erral
Copy link
Member Author

erral commented Oct 5, 2024

Thanks for the docs!

Thanks for your review!!!

Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice idea.

version = 6.0.13
template = plone_addon
git_init = True
python = python3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

backend_addon/{{ cookiecutter.__folder_name }}/README.md Outdated Show resolved Hide resolved
@erral
Copy link
Member Author

erral commented Oct 5, 2024

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

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two suggestions left to resolve.

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@erral Any update?

Copy link
Member Author

@erral erral Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

release is out ;)

stevepiercy added a commit to plone/documentation that referenced this pull request Oct 9, 2024
* Add more references. See plone/cookieplone-templates#63

* Incorporate @erral's suggestions, I think
@erral
Copy link
Member Author

erral commented Oct 10, 2024

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 🤔

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

@MrTango MrTango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great

@MrTango
Copy link

MrTango commented Nov 5, 2024

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
Copy link
Member Author

erral commented Nov 5, 2024

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 :)

erral and others added 14 commits November 13, 2024 21:14
…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/permissions.zcml

Co-authored-by: Steve Piercy <[email protected]>
…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/profiles/default/controlpanel.xml

Co-authored-by: Steve Piercy <[email protected]>
…tter.__package_namespace }}/{{ cookiecutter.__package_name }}/vocabularies/configure.zcml

Co-authored-by: Steve Piercy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants