Merge branch 'main' into erral-gitlab-improvements

plone · Nov 28, 2024 · a2f8e9a · a2f8e9a
2 parents a20657d + f3a6293
commit a2f8e9a
Show file tree

Hide file tree

Showing 25 changed files with 102 additions and 23 deletions.
diff --git a/.github/workflows/frontend_addon.yml b/.github/workflows/frontend_addon.yml
@@ -7,13 +7,11 @@ on:
   workflow_dispatch:
 
 env:
-  NODE_VERSION: 20.x
+  NODE_VERSION: 22.x
   PYTHON_VERSION: "3.10"
 
 jobs:
-
   generation:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -34,7 +32,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+          cache: "pip"
 
       # python install
       - name: Install dependencies
@@ -57,8 +55,8 @@ jobs:
       - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v5
         with:
-          python-version: '${{ env.PYTHON_VERSION }}'
-          cache: 'pip'
+          python-version: "${{ env.PYTHON_VERSION }}"
+          cache: "pip"
 
       - name: Install dependencies
         run: |

diff --git a/.github/workflows/project.yml b/.github/workflows/project.yml
@@ -6,10 +6,11 @@ on:
       - ".github/workflows/project.yml"
   workflow_dispatch:
 
-jobs:
+env:
+  NODE_VERSION: 22.x
 
+jobs:
   generation:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -30,13 +31,19 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+          cache: "pip"
 
       # python install
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
 
+      # Node setup
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
       # Test
       - name: Run tests
         run: |

diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/.mrbob.ini b/backend_addon/{{ cookiecutter.__folder_name }}/.mrbob.ini
@@ -0,0 +1,4 @@
+[variables]
+package.dottedname = {{ cookiecutter.python_package_name }}
+package.browserlayer = IBrowserLayer
+
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/Makefile b/backend_addon/{{ cookiecutter.__folder_name }}/Makefile
@@ -62,7 +62,7 @@ config: instance/etc/zope.ini
 build-dev: config ## Install Plone packages
 	@echo "$(GREEN)==> Setup Build$(RESET)"
 	$(BIN_FOLDER)/pipx run mxdev -c mx.ini
-	$(BIN_FOLDER)/uv pip install -r requirements-mxdev.txt
+	VIRTUAL_ENV=.venv $(BIN_FOLDER)/uv pip install -r requirements-mxdev.txt
 
 .PHONY: install
 install: build-dev ## Install Plone
@@ -100,7 +100,7 @@ check: $(BIN_FOLDER)/tox ## Check and fix code base according to Plone standards
 # i18n
 $(BIN_FOLDER)/i18ndude: $(BIN_FOLDER)/pip
 	@echo "$(GREEN)==> Install translation tools$(RESET)"
-	$(BIN_FOLDER)/uv pip install i18ndude
+	VIRTUAL_ENV=.venv $(BIN_FOLDER)/uv pip install i18ndude
 
 .PHONY: i18n
 i18n: $(BIN_FOLDER)/i18ndude ## Update locales
@@ -115,3 +115,7 @@ test: $(BIN_FOLDER)/tox ## run tests
 .PHONY: test-coverage
 test-coverage: $(BIN_FOLDER)/tox ## run tests with coverage
 	$(BIN_FOLDER)/tox -e coverage
+
+## Add bobtemplates features (check bobtemplates.plone's documentation to get the list of available features)
+add: $(BIN_FOLDER)/pipx
+	$(BIN_FOLDER)/pipx run plonecli add -b .mrbob.ini $(filter-out $@,$(MAKECMDGOALS))
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/README.md b/backend_addon/{{ cookiecutter.__folder_name }}/README.md
@@ -13,12 +13,41 @@ Install {{ cookiecutter.python_package_name }} with `pip`:
 ```shell
 pip install {{ cookiecutter.python_package_name }}
 ```
+
 And to create the Plone site:
 
 ```shell
 make create_site
 ```
 
+## Add features using `plonecli` or `bobtemplates.plone`
+
+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 run `plonecli` with configuration to target this package, run the following command.
+
+```shell
+make add <template_name>
+```
+
+For example, you can add a content type to your package with the following command.
+
+```shell
+make add content_type
+```
+
+You can add a behavior with the following command.
+
+```shell
+make add behavior
+```
+
+```{seealso}
+You can check the list of available subtemplates in the [`bobtemplates.plone` `README.md` file](https://github.com/plone/bobtemplates.plone/?tab=readme-ov-file#provided-subtemplates).
+See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.
+```
+
 ## Contribute
 
 - [Issue Tracker](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.python_package_name }}/issues)

diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/bobtemplate.cfg b/backend_addon/{{ cookiecutter.__folder_name }}/bobtemplate.cfg
@@ -0,0 +1,5 @@
+[main]
+version = 6.0.13
+template = plone_addon
+git_init = True
+python = python3
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/configure.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/configure.zcml
@@ -11,8 +11,10 @@
       file="permissions.zcml"
       />
 
+
   <include file="dependencies.zcml" />
   <include file="profiles.zcml" />
+  <include file="permissions.zcml"/>
 
   <include package=".controlpanel" />
   <include package=".indexers" />
@@ -21,4 +23,6 @@
   {%- endif %}
   <include package=".vocabularies" />
 
+  <!-- -*- extra stuff goes here -*- -->
+
 </configure>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/controlpanel/configure.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/controlpanel/configure.zcml
@@ -5,4 +5,6 @@
     i18n_domain="{{ cookiecutter.python_package_name }}"
     >
 
+  <!-- -*- extra stuff goes here -*- -->
+
 </configure>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/indexers/configure.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/indexers/configure.zcml
@@ -2,4 +2,6 @@
 
   <!-- Indexers/Metadata -->
 
+  <!-- -*- extra stuff goes here -*- -->
+
 </configure>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/permissions.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/permissions.zcml
@@ -0,0 +1,9 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
+    i18n_domain="{{ cookiecutter.python_package_name }}"
+    >
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>
diff --git a/..._addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/controlpanel.xml b/..._addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/controlpanel.xml
@@ -1,4 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <object name="portal_controlpanel">
 
+<!-- -*- extra stuff goes here -*- -->
+
 </object>
diff --git a/...addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/registry/.gitkeep b/...addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/registry/.gitkeep
diff --git a/...addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/registry/main.xml b/...addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/registry/main.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<registry
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    i18n:domain="{{ cookiecutter.python_package_name }}">
+
+<!-- -*- extra stuff goes here -*- -->
+
+</registry>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/rolemap.xml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/profiles/default/rolemap.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <rolemap>
   <permissions>
-
+    <!-- -*- extra stuff goes here -*- -->
   </permissions>
 </rolemap>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/upgrades/configure.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/upgrades/configure.zcml
@@ -16,4 +16,6 @@
   </genericsetup:upgradeSteps>
   -->
 
+  <!-- -*- extra stuff goes here -*- -->
+
 </configure>
diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/vocabularies/configure.zcml b/backend_addon/{{ cookiecutter.__folder_name }}/src/packagename/vocabularies/configure.zcml
@@ -1,3 +1,5 @@
 <configure xmlns="http://namespaces.zope.org/zope">
 
+    <!-- -*- extra stuff goes here -*- -->
+
 </configure>
diff --git a/frontend_addon/cookiecutter.json b/frontend_addon/cookiecutter.json
@@ -1,6 +1,6 @@
 {
   "title": "Volto Add-on",
-  "frontend_addon_name": "volto-addon",
+  "frontend_addon_name": "{{ cookiecutter.title | slugify }}",
   "description": "A new add-on for Volto",
   "author": "Plone Community",
   "email": "collective@plone.org",

diff --git a/project/cookiecutter.json b/project/cookiecutter.json
@@ -53,7 +53,7 @@
   "__devops_traefik_stack_include_ui": "no",
   "__devops_traefik_docker_network": "{{ cookiecutter.__devops_stack_name }}_{{ cookiecutter.__devops_swarm_stack_network }}",
   "__devops_varnish_version": "7.6",
-  "__devops_db_version": "14",
+  "__devops_db_version": "14.15",
   "__devops_db_password": "{{ random_ascii_string(12) }}",
   "__backend_addon_git_initialize": "0",
   "__backend_addon_format": "1",

diff --git a/project/{{ cookiecutter.__folder_name }}/devops/.env_dist b/project/{{ cookiecutter.__folder_name }}/devops/.env_dist
@@ -3,6 +3,5 @@ DEPLOY_ENV=prod
 DEPLOY_HOST={{ cookiecutter.hostname }}
 DEPLOY_PORT=22
 DEPLOY_USER=plone
-DEPLOY_FOLDER=/srv/{{ cookiecutter.project_slug }}/data
 DOCKER_CONFIG=.docker
 STACK_NAME={{ cookiecutter.__devops_stack_name }}
diff --git a/project/{{ cookiecutter.__folder_name }}/devops/README-GHA.md b/project/{{ cookiecutter.__folder_name }}/devops/README-GHA.md
@@ -28,7 +28,7 @@ After setting up the environment, it's time to add secrets. These are sensitive
 | DEPLOY_PORT | 22 | The SSHD Port. |
 | DEPLOY_USER | plone | The user to connect to the deploy host, with permissions to run Docker commands. |
 | DEPLOY_SSH  | Contents of `devops/etc/keys/plone_prod_deploy_ed25519` | The private SSH key used for connection. The corresponding public key should be in the `~/.ssh/authorized_keys` file of the deployment user. |
-| ENV_FILE    | Contents of `devops/.env_file_gha` | The file containing environment variables used by the stack file. |
+| ENV_FILE    | Contents of `devops/.env_gha` | The file containing environment variables used by the stack file. |
 
 ### Step 3: Add Repository Variables 📚
 

diff --git a/project/{{ cookiecutter.__folder_name }}/devops/README.md b/project/{{ cookiecutter.__folder_name }}/devops/README.md
@@ -46,7 +46,6 @@ DEPLOY_ENV=prod
 DEPLOY_HOST={{ cookiecutter.hostname }}
 DEPLOY_PORT=22
 DEPLOY_USER=plone
-DEPLOY_FOLDER=/srv/{{ cookiecutter.project_slug }}/data
 DOCKER_CONFIG=.docker
 STACK_NAME={{ cookiecutter.__devops_stack_name }}
 ```

diff --git a/project/{{ cookiecutter.__folder_name }}/devops/inventory/group_vars/all/projects.yml b/project/{{ cookiecutter.__folder_name }}/devops/inventory/group_vars/all/projects.yml
@@ -1,7 +1,6 @@
 ---
 project_folders:
-  # Path to store {{ cookiecutter.hostname }} postgres data
-  - path: {{ "\"{{ lookup('ansible.builtin.env', 'DEPLOY_FOLDER', default='/srv/plone/data') }}\"" }}
+  - path: "/srv/{{ cookiecutter.project_slug }}/data"
     owner: 999
     group: 999
     mode: "0750"
diff --git a/project/{{ cookiecutter.__folder_name }}/devops/stacks/{{ cookiecutter.hostname }}.yml b/project/{{ cookiecutter.__folder_name }}/devops/stacks/{{ cookiecutter.hostname }}.yml
@@ -261,7 +261,7 @@ volumes:
   vol-site-data:
     driver_opts:
       type: none
-      device: ${DEPLOY_FOLDER:-/srv/{{ cookiecutter.project_slug }}/data}
+      device: "/srv/{{ cookiecutter.project_slug }}/data"
       o: bind
 
 networks:

diff --git a/project/{{ cookiecutter.__folder_name }}/devops/tasks/swarm/task_swarm.yml b/project/{{ cookiecutter.__folder_name }}/devops/tasks/swarm/task_swarm.yml
@@ -4,7 +4,6 @@
 
 - name: "Docker Swarm: Initial Setup"
   block:
-
     - name: "Docker Swarm: Init Swarm"
       community.docker.docker_swarm:
         state: present
@@ -17,12 +16,12 @@
   block:
     - name: "Docker Swarm: Check for public network"
       community.docker.docker_network_info:
-        name: "{{ cookiecutter.__devops_swarm_public_network }}"
+        name: "{{ swarm.public_network }}"
       register: docker_swarm_net_public
 
     - name: "Docker Swarm: Create public network"
       community.docker.docker_network:
-        name: "{{ cookiecutter.__devops_swarm_public_network }}"
+        name: "{{ swarm.public_network }}"
         internal: false
         attachable: true
         driver: overlay

diff --git a/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/Makefile b/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/Makefile
@@ -149,3 +149,8 @@ acceptance-image-build:  ## Build Docker Images
 	{%- else %}
 	@DOCKER_BUILDKIT=1 docker build . -t $(IMAGE_NAME_PREFIX)-backend-acceptance:$(IMAGE_TAG) -f Dockerfile.acceptance --build-arg PLONE_VERSION=$(PLONE_VERSION)
 	{%- endif %}
+
+## Add bobtemplates features (check bobtemplates.plone's documentation to get the list of available features)
+add: $(BIN_FOLDER)/pipx
+	$(BIN_FOLDER)/pipx run plonecli add -b .mrbob.ini $(filter-out $@,$(MAKECMDGOALS))
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,6 @@

		<!-- Indexers/Metadata -->

		<!-- -- extra stuff goes here -- -->

		</configure>