fix files

Author: cekk

.github/workflows/main.yml

@@ -1,23 +1,23 @@
-name: Blocks listing CI
+name: Search blocks CI
 
 on:
   push:
     paths:
-      - "backend/**"
-      - "frontend/**"
-      - ".github/workflows/backend.yml"
-      - "docs/**"
-      - ".github/workflows/docs.yml"
+      - 'backend/**'
+      - 'frontend/**'
+      - '.github/workflows/backend.yml'
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
       - .readthedocs.yaml
-      - ".github/workflows/frontend.yml"
-      - ".github/workflows/main.yml"
-      - "devops/**"
+      - '.github/workflows/frontend.yml'
+      - '.github/workflows/main.yml'
+      - 'devops/**'
   workflow_dispatch:
 
 env:
-  IMAGE_NAME_PREFIX: ghcr.io/collective/collective-blockslisting
-  NODE_VERSION: "22.x"
-  PYTHON_VERSION: "3.12"
+  IMAGE_NAME_PREFIX: ghcr.io/collective/collective-searchblocks
+  NODE_VERSION: '22.x'
+  PYTHON_VERSION: '3.12'
 
 jobs:
   config:
@@ -70,13 +70,13 @@ jobs:
   backend:
     uses: ./.github/workflows/backend.yml
     needs:
-        - config
+      - config
     with:
-        base-tag: ${{ needs.config.outputs.BASE_TAG }}
-        image-name-prefix: ${{ needs.config.outputs.IMAGE_NAME_PREFIX }}
-        image-name-suffix: backend
-        python-version: ${{ needs.config.outputs.PYTHON_VERSION }}
-        plone-version: ${{ needs.config.outputs.PLONE_VERSION }}
+      base-tag: ${{ needs.config.outputs.BASE_TAG }}
+      image-name-prefix: ${{ needs.config.outputs.IMAGE_NAME_PREFIX }}
+      image-name-suffix: backend
+      python-version: ${{ needs.config.outputs.PYTHON_VERSION }}
+      plone-version: ${{ needs.config.outputs.PLONE_VERSION }}
     if: ${{ needs.config.outputs.backend == 'true' }}
     permissions:
       contents: read
@@ -85,28 +85,28 @@ jobs:
   docs:
     uses: ./.github/workflows/docs.yml
     needs:
-        - config
+      - config
     with:
-        python-version: ${{ needs.config.outputs.PYTHON_VERSION }}
+      python-version: ${{ needs.config.outputs.PYTHON_VERSION }}
     if: ${{ needs.config.outputs.docs == 'true' }}
 
   frontend:
     uses: ./.github/workflows/frontend.yml
     needs:
-        - config
+      - config
     with:
-        base-tag: ${{ needs.config.outputs.BASE_TAG }}
-        image-name-prefix: ${{ needs.config.outputs.IMAGE_NAME_PREFIX }}
-        image-name-suffix: frontend
-        node-version: ${{ needs.config.outputs.NODE_VERSION }}
-        volto-version: ${{ needs.config.outputs.VOLTO_VERSION }}
+      base-tag: ${{ needs.config.outputs.BASE_TAG }}
+      image-name-prefix: ${{ needs.config.outputs.IMAGE_NAME_PREFIX }}
+      image-name-suffix: frontend
+      node-version: ${{ needs.config.outputs.NODE_VERSION }}
+      volto-version: ${{ needs.config.outputs.VOLTO_VERSION }}
     if: ${{ needs.config.outputs.frontend == 'true' }}
     permissions:
       contents: read
       packages: write
 
   report:
-    name: "Final report"
+    name: 'Final report'
     if: ${{ always() }}
     runs-on: ubuntu-latest
     needs:

.github/workflows/manual_deploy.yml

@@ -1,11 +1,9 @@
-name: Manual Deployment of collective-blockslisting.example.com
+name: Manual Deployment of collective-searchblocks.example.com
 
 on:
   workflow_dispatch:
 
-
 jobs:
-
   meta:
     runs-on: ubuntu-latest
     outputs:
@@ -35,7 +33,7 @@ jobs:
       - name: Deploy to cluster
         uses: kitconcept/docker-stack-deploy@v1.2.0
         with:
-          registry: "ghcr.io"
+          registry: 'ghcr.io'
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
           remote_host: ${{ secrets.DEPLOY_HOST }}

Makefile

@@ -11,8 +11,8 @@ MAKEFLAGS+=--no-builtin-rules
 CURRENT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 GIT_FOLDER=$(CURRENT_DIR)/.git
 
-PROJECT_NAME=collective-blockslisting
-STACK_NAME=collective-blockslisting-example-com
+PROJECT_NAME=collective-searchblocks
+STACK_NAME=collective-searchblocks-example-com
 
 VOLTO_VERSION=$(shell cat frontend/mrs.developer.json | python -c "import sys, json; print(json.load(sys.stdin)['core']['tag'])")
 PLONE_VERSION=$(shell cat backend/version.txt)
@@ -152,7 +152,7 @@ stack-create-site:  ## Local Stack: Create a new site
 stack-start:  ## Local Stack: Start Services
 	@echo "Start local Docker stack"
 	VOLTO_VERSION=$(VOLTO_VERSION) PLONE_VERSION=$(PLONE_VERSION) docker compose -f docker-compose.yml up -d --build
-	@echo "Now visit: http://collective-blockslisting.localhost"
+	@echo "Now visit: http://collective-searchblocks.localhost"
 
 .PHONY: stack-status
 stack-status:  ## Local Stack: Check Status
@@ -193,12 +193,12 @@ acceptance-test:
 .PHONY: acceptance-frontend-image-build
 acceptance-frontend-image-build:
 	@echo "Build acceptance frontend image"
-	@docker build frontend -t collective/collective-blockslisting-frontend:acceptance -f frontend/Dockerfile --build-arg VOLTO_VERSION=$(VOLTO_VERSION)
+	@docker build frontend -t collective/collective-searchblocks-frontend:acceptance -f frontend/Dockerfile --build-arg VOLTO_VERSION=$(VOLTO_VERSION)
 
 .PHONY: acceptance-backend-image-build
 acceptance-backend-image-build:
 	@echo "Build acceptance backend image"
-	@docker build backend -t collective/collective-blockslisting-backend:acceptance -f backend/Dockerfile.acceptance --build-arg PLONE_VERSION=$(PLONE_VERSION)
+	@docker build backend -t collective/collective-searchblocks-backend:acceptance -f backend/Dockerfile.acceptance --build-arg PLONE_VERSION=$(PLONE_VERSION)
 
 .PHONY: acceptance-images-build
 acceptance-images-build: ## Build Acceptance frontend/backend images
@@ -208,12 +208,12 @@ acceptance-images-build: ## Build Acceptance frontend/backend images
 .PHONY: acceptance-frontend-container-start
 acceptance-frontend-container-start:
 	@echo "Start acceptance frontend"
-	@docker run --rm -p 3000:3000 --name collective-blockslisting-frontend-acceptance --link collective-blockslisting-backend-acceptance:backend -e RAZZLE_API_PATH=http://localhost:55001/plone -e RAZZLE_INTERNAL_API_PATH=http://backend:55001/plone -d collective/collective-blockslisting-frontend:acceptance
+	@docker run --rm -p 3000:3000 --name collective-searchblocks-frontend-acceptance --link collective-searchblocks-backend-acceptance:backend -e RAZZLE_API_PATH=http://localhost:55001/plone -e RAZZLE_INTERNAL_API_PATH=http://backend:55001/plone -d collective/collective-searchblocks-frontend:acceptance
 
 .PHONY: acceptance-backend-container-start
 acceptance-backend-container-start:
 	@echo "Start acceptance backend"
-	@docker run --rm -p 55001:55001 --name collective-blockslisting-backend-acceptance -d collective/collective-blockslisting-backend:acceptance
+	@docker run --rm -p 55001:55001 --name collective-searchblocks-backend-acceptance -d collective/collective-searchblocks-backend:acceptance
 
 .PHONY: acceptance-containers-start
 acceptance-containers-start: ## Start Acceptance containers
@@ -223,8 +223,8 @@ acceptance-containers-start: ## Start Acceptance containers
 .PHONY: acceptance-containers-stop
 acceptance-containers-stop: ## Stop Acceptance containers
 	@echo "Stop acceptance containers"
-	@docker stop collective-blockslisting-frontend-acceptance
-	@docker stop collective-blockslisting-backend-acceptance
+	@docker stop collective-searchblocks-frontend-acceptance
+	@docker stop collective-searchblocks-backend-acceptance
 
 .PHONY: ci-acceptance-test
 ci-acceptance-test:

README.md

@@ -1,8 +1,8 @@
-# Blocks listing 🚀
+# Search blocks 🚀
 
 [![Built with Cookieplone](https://img.shields.io/badge/built%20with-Cookieplone-0083be.svg?logo=cookiecutter)](https://github.com/plone/cookieplone-templates/)
 [![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![CI](https://github.com/collective/collective-blockslisting/actions/workflows/main.yml/badge.svg)](https://github.com/collective/collective-blockslisting/actions/workflows/main.yml)
+[![CI](https://github.com/collective/collective-searchblocks/actions/workflows/main.yml/badge.svg)](https://github.com/collective/collective-searchblocks/actions/workflows/main.yml)
 
 A comprehensive solution for searching and managing content that uses specific blocks in Plone and Volto.
 
@@ -33,8 +33,8 @@ A comprehensive solution for searching and managing content that uses specific b
 1.  Clone this repository, then change your working directory.
 
     ```shell
-    git clone git@github.com:collective/collective-blockslisting.git
-    cd collective-blockslisting
+    git clone git@github.com:collective/collective-searchblocks.git
+    cd collective-searchblocks
     ```
 
 2.  Install this code base.
@@ -72,7 +72,7 @@ Deploy a local Docker Compose environment that includes the following.
 
 - Docker images for Backend and Frontend 🖼️
 - A stack with a Traefik router and a PostgreSQL database 🗃️
-- Accessible at [http://collective-blockslisting.localhost](http://collective-blockslisting.localhost) 🌐
+- Accessible at [http://collective-searchblocks.localhost](http://collective-searchblocks.localhost) 🌐
 
 Run the following commands in a shell session.
 
@@ -87,7 +87,7 @@ And... you're all set! Your Plone site is up and running locally! 🚀
 
 This monorepo consists of the following distinct sections:
 
-- **backend**: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named collective.blockslisting.
+- **backend**: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named collective.searchblocks.
 - **frontend**: Contains the React (Volto) package.
 - **devops**: Encompasses Docker stack, Ansible playbooks, and cache settings.
 - **docs**: Scaffold for writing documentation for your project.

devops/README-GHA.md

@@ -9,11 +9,11 @@ Welcome to the DevOps operations guide for deploying your project using GitHub A
 ### Step 1: Create a New Environment
 
 1. Visit [GitHub](https://github.com/) and log in with your credentials.
-2. Go to your repository at [collective/collective-blockslisting](https://github.com/collective/collective-blockslisting).
+2. Go to your repository at [collective/collective-searchblocks](https://github.com/collective/collective-searchblocks).
 3. Click on `Settings` at the top-right corner.
 4. In the left sidebar, click on `Environments`.
 5. Press `New environment`.
-6. Name the environment `collective-blockslisting.example.com` and hit `Configure environment`.
+6. Name the environment `collective-searchblocks.example.com` and hit `Configure environment`.
 
 ### Step 2: Add Environment Secrets 🔒
 
@@ -24,7 +24,7 @@ After setting up the environment, it's time to add secrets. These are sensitive
 
 | Secret Name | Secret Value | Description |
 |-------------|--------------|-------------|
-| DEPLOY_HOST | collective-blockslisting.example.com | The hostname or IP address of your Docker Swarm manager. |
+| DEPLOY_HOST | collective-searchblocks.example.com | The hostname or IP address of your Docker Swarm manager. |
 | 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. |
@@ -40,30 +40,30 @@ Add the repository variable as follows:
 
 | Name     | Value |
 |----------|-------|
-| LIVE_ENV | collective-blockslisting.example.com |
+| LIVE_ENV | collective-searchblocks.example.com |
 
 This variable is referenced in the `.github/workflows/manual_deploy.yml` file.
 
 ## Manual Deployment 🚀
 
 Ensure that both Backend and Frontend tests have been successfully executed:
 
-- [Backend Tests Workflow](https://github.com/collective/collective-blockslisting/actions/workflows/backend.yml)
-- [Frontend Tests Workflow](https://github.com/collective/collective-blockslisting/actions/workflows/frontend.yml)
+- [Backend Tests Workflow](https://github.com/collective/collective-searchblocks/actions/workflows/backend.yml)
+- [Frontend Tests Workflow](https://github.com/collective/collective-searchblocks/actions/workflows/frontend.yml)
 
-Upon successful completion of the tests, Docker images for the Backend (`ghcr.io/collective/collective-blockslisting-backend`) and Frontend (`ghcr.io/collective/collective-blockslisting-frontend`) will be available.
+Upon successful completion of the tests, Docker images for the Backend (`ghcr.io/collective/collective-searchblocks-backend`) and Frontend (`ghcr.io/collective/collective-searchblocks-frontend`) will be available.
 
 ### Initiating Manual Deployment
 
-1. Navigate to [Manual Deployment of collective-blockslisting.example.com](https://github.com/collective/collective-blockslisting/actions/workflows/manual-deploy.yml).
+1. Navigate to [Manual Deployment of collective-searchblocks.example.com](https://github.com/collective/collective-searchblocks/actions/workflows/manual-deploy.yml).
 2. Click on `Run workflow`.
 3. Select `Branch: main` under **Use workflow from**.
 4. Press `Run workflow`.
 
 The workflow will execute the following actions:
 
 - Connect to **DEPLOY_HOST** using **DEPLOY_USER** and **DEPLOY_SSH** key.
-- Initiate a new deployment using the `devops/stacks/collective-blockslisting.example.com.yml` stack.
+- Initiate a new deployment using the `devops/stacks/collective-searchblocks.example.com.yml` stack.
 - Provide a detailed report of the deployment outcome.
 
 Congratulations! 🎉 You've successfully configured and initiated a manual deployment using GitHub Actions. Monitor the workflow for real-time updates on the deployment process.

devops/README-GITLAB.md

@@ -11,7 +11,7 @@ See [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/).
 ### Step 1: Add the deployment environment variables
 
 1.  Visit [GitLab](https://gitlab.com/), or your organization's GitLab instance, and log in with your credentials.
-2.  Go to your repository at [collective/collective-blockslisting](https://gitlab.com/collective/collective-blockslisting).
+2.  Go to your repository at [collective/collective-searchblocks](https://gitlab.com/collective/collective-searchblocks).
     Note that you might need to adjust the URL's host name to your organization's.
 3.  Click on `Settings` at the left menu and select `CI/CD`.
 4.  Expand the `Variables`.

devops/stacks/collective-blockslisting.example.com.yml

@@ -25,7 +25,7 @@ services:
         ### echo $(htpasswd -nb user password) | sed -e s/\\$/\\$\\$/g
         ### Defaults to admin:admin
         #- traefik.http.middlewares.admin-auth.basicauth.users=admin:$$apr1$$uZPT5Fgu$$AmlIdamxT5ipBvPlsdfD70
-        #- traefik.http.routers.traefik-public-https.rule=Host(`traefik-collective-blockslisting.example.com`)
+        #- traefik.http.routers.traefik-public-https.rule=Host(`traefik-collective-searchblocks.example.com`)
         #- traefik.http.routers.traefik-public-https.entrypoints=https
         #- traefik.http.routers.traefik-public-https.tls=true
         #- traefik.http.routers.traefik-public-https.service=api@internal
@@ -52,7 +52,7 @@ services:
       - --providers.docker.constraints=Label(`traefik.constraint-label`, `public`)
       - --providers.docker.exposedbydefault=false
       - --providers.docker.swarmmode
-      - --providers.docker.network=collective-blockslisting-example-com_nw-internal
+      - --providers.docker.network=collective-searchblocks-example-com_nw-internal
       - --entrypoints.http.address=:80
       - --entrypoints.https.address=:443
       - --certificatesresolvers.le.acme.email=sviluppo@redturtle.it
@@ -68,10 +68,10 @@ services:
       - nw-internal
 
   frontend:
-    image: ghcr.io/collective/collective-blockslisting-frontend:${STACK_PARAM:-latest}
+    image: ghcr.io/collective/collective-searchblocks-frontend:${STACK_PARAM:-latest}
     environment:
       RAZZLE_INTERNAL_API_PATH: http://backend:8080/Plone
-      RAZZLE_API_PATH: https://collective-blockslisting.example.com
+      RAZZLE_API_PATH: https://collective-searchblocks.example.com
     depends_on:
       - backend
     networks:
@@ -90,15 +90,15 @@ services:
         - traefik.http.services.svc-frontend.loadbalancer.server.port=3000
         # Routers
         ## /
-        - traefik.http.routers.rt-frontend.rule=Host(`collective-blockslisting.example.com`)
+        - traefik.http.routers.rt-frontend.rule=Host(`collective-searchblocks.example.com`)
         - traefik.http.routers.rt-frontend.entrypoints=https
         - traefik.http.routers.rt-frontend.tls=true
         - traefik.http.routers.rt-frontend.tls.certresolver=le
         - traefik.http.routers.rt-frontend.service=svc-frontend
         - traefik.http.routers.rt-frontend.middlewares=gzip
 
   backend:
-    image: ghcr.io/collective/collective-blockslisting-backend:${STACK_PARAM:-latest}
+    image: ghcr.io/collective/collective-searchblocks-backend:${STACK_PARAM:-latest}
     environment:
       RELSTORAGE_DSN: "dbname='${DB_NAME:-plone}' user='${DB_USER:-plone}' host='${DB_HOST:-db}' password='${DB_PASSWORD:-cInYVdqIftBC}' port='${DB_PORT:-5432}'"
     depends_on:
@@ -120,10 +120,10 @@ services:
         # Middlewares
         ## VHM rewrite /++api++/
         - "traefik.http.middlewares.mw-backend-vhm-api.replacepathregex.regex=^/\\+\\+api\\+\\+($$|/.*)"
-        - "traefik.http.middlewares.mw-backend-vhm-api.replacepathregex.replacement=/VirtualHostBase/https/collective-blockslisting.example.com/Plone/++api++/VirtualHostRoot$$1"
+        - 'traefik.http.middlewares.mw-backend-vhm-api.replacepathregex.replacement=/VirtualHostBase/https/collective-searchblocks.example.com/Plone/++api++/VirtualHostRoot$$1'
         ## VHM rewrite /ClassicUI/
-        - "traefik.http.middlewares.mw-backend-vhm-classic.replacepathregex.regex=^/ClassicUI($$|/.*)"
-        - "traefik.http.middlewares.mw-backend-vhm-classic.replacepathregex.replacement=/VirtualHostBase/https/collective-blockslisting.example.com/Plone/VirtualHostRoot/_vh_ClassicUI$$1"
+        - 'traefik.http.middlewares.mw-backend-vhm-classic.replacepathregex.regex=^/ClassicUI($$|/.*)'
+        - 'traefik.http.middlewares.mw-backend-vhm-classic.replacepathregex.replacement=/VirtualHostBase/https/collective-searchblocks.example.com/Plone/VirtualHostRoot/_vh_ClassicUI$$1'
         ## Basic Authentication
         ### Note: all dollar signs in the hash need to be doubled for escaping.
         ### To create user:password pair, it's possible to use this command:
@@ -134,13 +134,13 @@ services:
 
         # Routes
         ## /++api++
-        - traefik.http.routers.rt-backend-api.rule=Host(`collective-blockslisting.example.com`) && PathPrefix(`/++api++`)
+        - traefik.http.routers.rt-backend-api.rule=Host(`collective-searchblocks.example.com`) && PathPrefix(`/++api++`)
         - traefik.http.routers.rt-backend-api.entrypoints=https
         - traefik.http.routers.rt-backend-api.tls=true
         - traefik.http.routers.rt-backend-api.service=svc-backend
         - traefik.http.routers.rt-backend-api.middlewares=gzip,mw-backend-vhm-api
         ## /ClassicUI
-        - traefik.http.routers.rt-backend-classic.rule=Host(`collective-blockslisting.example.com`) && PathPrefix(`/ClassicUI`)
+        - traefik.http.routers.rt-backend-classic.rule=Host(`collective-searchblocks.example.com`) && PathPrefix(`/ClassicUI`)
         - traefik.http.routers.rt-backend-classic.entrypoints=https
         - traefik.http.routers.rt-backend-classic.tls=true
         - traefik.http.routers.rt-backend-classic.service=svc-backend
@@ -168,7 +168,7 @@ volumes:
   vol-site-data:
     driver_opts:
       type: none
-      device: "/srv/collective-blockslisting/data"
+      device: '/srv/collective-searchblocks/data'
       o: bind
 
 networks: