a 'make help' could help #1014
Comments
|
a 'make help' would also print that there is no 'make start' but a 'make run'. |
|
I got it running. If I can help with the 'make help', just ping me. I don't want to fiddle with the Makefile if the authors have strong opinions about how it should look like. |
|
I think this is based on mxmake, which got a help system added recently: mxstack/mxmake#44 I am not very familiar with mxmake. Maybe @jensens has tips for how to update it? |
|
just run |
If I get you right, you point contributors to https://github.com/plone/buildout.coredev/blob/6.1/README-make.md I wonder if the use of the Makefile and the setup without buildout should be mentioned in the documentation: |
|
Sorry, I'm not familiar with the buildout vs. mxmake machinery. I think some kind of write-up in the Plone 6 Documentation is needed, but I don't know exactly what or where. That said, https://6.docs.plone.org/contributing/core/#install-plone-core-for-development is for contributing to Plone core. @ksuess do you mean instead developing via pip or buildout? |
|
@stevepiercy I am talking about contributing to core. We can set up Plone for contributing to core like done since years with buildout. This is explained here https://6.docs.plone.org/contributing/core/#install-plone-core-for-development. We can still do. Or we can use the new Makefile (Sept 2024 f13c4c5#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52) to set up Plone for contributing to core WITHOUT buildout, made by @mauritsvanrees and @jensens with mxmake, mxdev, uv, etc.. It's a great relief to go without buildout, IMHO. If included in docs.plone.org, new contributors do not have to learn buildout. Those who have a set up running, do not need to switch, as the setup with buildout is still OK. |
|
@ksuess yes, please! Let's promote it as recommended, and deprecate buildout as "at your own risk". I'd appreciate a PR that we can review. I'd suggest this structure, renaming that heading slightly. ## Install Plone core for contributing
New method name TBD is the preferred method to install Plone core for contributing.
Buildout will be deprecated in Plone 6.2, and will no longer receive support for Plone installations in Plone 7. (This sentence probably requires a PLIP, but YOLO!)
### New method name TBD
versionadded admonition
How to guide for TBD.
### Buildout
deprecated admonition
existing content |
It definitely needs a PLIP. There is still significant use of buildout within the community, especially for Classic UI projects. There are also some parts of the Plone development and release process that still depend on the coredev buildout. For example the Jenkins test runs use a command that is created by this buildout to run tests from all Plone packages. The intention is to replace all those things with Makefile commands, but that's not done yet. I'm fine with recommending that contributors use the Makefile commands, but it's a bit premature to say the buildout is deprecated. |
|
So I will pick up and continue with plone/documentation#1936 for recommending that contributors use the Makefile commands which go without buildout. |
What I meant is I added a help feature to mxmake, it just need to be activated for the Makefile as mentioned above. |
|
Done and pushed to 6.2 branch. |
|
@ksuess I think this can be closed now? |
|
@jensens I tried it and see output like this: Is there a way to show a description for each target? |
The dev setup without buildout could be awesome.
how about a 'make help'?
and a 'make clean-xy' (I get several errors)
The text was updated successfully, but these errors were encountered: