Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 3.13 KB

README_MAKE.md

File metadata and controls

89 lines (65 loc) · 3.13 KB

Information about the Makefile

How to use this pip, mxdev, cookiecutter-zope-instance and make based install.

Usage

On the command-line, execute the make command. Without any options, make will run all steps.

make run

All options are printed with

make help

Here some of the important ones:

run         run Plone
test        run tests
lint        lint all: check if complies with code-styles black, isort and zpretty
style       format code (black, isort, zpretty)
prepare     prepare sources and dependencies
install     pip install all dependencies and scripts
instance    create configuration for an zope (plone) instance
clean       remove instance configuration (keeps data)
...

Order for make run is: prepare, install, instance, run.

The Makefile is built to detect changes. At the first make run all steps are executed. Subsequent calls are only starting the application server in the run step. If one of the input file is changed, steps needed to take those changes into effect are executed again.\

Python

By default the command python3 is used. By calling i.e. make PYTHON=python3.9.8 run this can be changed.

The Makefile support different modes of Python:

  1. Create new virtualenv under ./venv (default) from a global Python 3. python3 is expected to be in the PATH.
  2. Like (1), but the VENV_FOLDER is passed to every make call: make VENV_FOLDER=./some_folder/ install.
  3. make VENV=off install: Direct usage of current configure Python 3 environment. Like if one uses pyenv or another already activated virtual environment, or in CI if the environment is already isolated.
  4. Like (3), but the environment is not activated, so we need to point make to the location with make VENV=off VENV_FOLDER=~/myenv/myproject_venv or alike.

Attention: if those parameters are used, they must be passed to every make call! Setting them as environment variables like export VENV=off works too.

Hint: Edit the Makefile and look for VENV?=on (which sets the default). And VENV_FOLDER?= (look for the if before) and adjust to your needs.

Files

Initially the files below were generated by plone-kickstarter. They are meant to be modified for your needs.

They aim to ease development and deployment of Plone 6+

constraints.txt Version pins for your project, used by pip. README_MAKE.md (this file) instance.yaml Zope/Plone application server configuration. Used by cookiecutter-zope-instance Makefile The configuration for make requirement{%- if cookiecutter.mode == "adon" %}_barebone{%- endif %}.txt The core requirements. sources.ini mxdev is used to develop with sources from VCS like Git. If you need sources from git, add them here.

Dockerfile Minimal configuration to build an Docker image using make based on the official plone-backend <https://github.com/plone/plone-backend>_ image.

Tools

The configuration here uses: