From 5c19fccf1e0230b1076b91736a6829a3ef12f275 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 12 Sep 2022 02:07:23 +0000 Subject: [PATCH 01/12] Add notes on how to install addon packages in an extended container. --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 21922f1..42a6fbd 100644 --- a/README.md +++ b/README.md @@ -115,16 +115,27 @@ FROM plone/plone-backend:6.0.0b2 RUN ./bin/pip install "relstorage==3.4.5" "psycopg2==2.9.3 --use-deprecated legacy-resolver" ``` -Also create a `requirements.txt` file, with packages to be installed: +Make sure any Plone add-ons you are adding via `pip install` have their corresponding entry +points declared in `setup.py` — otherwise they will not be loaded by Plone: -```plain -pas.plugin.authomatic ``` +... + entry_points=""" + [z3c.autoinclude.plugin] + target = plone + """, +... + +``` + +Also make sure that your add-ons do not use `zc3.autoinclude` in their `configure.zcml` +configuration file. -Build your new image +Now build your new image: ```shell docker build . -t myproject:latest -f Dockerfile +# buildah build works too ``` And start a container with From 62c1d12d9b05e1ef2e0ecb5838f1cfcedf2f1762 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 12 Sep 2022 02:09:32 +0000 Subject: [PATCH 02/12] Better description of configure.zcml with example. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 42a6fbd..a930544 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,15 @@ points declared in `setup.py` — otherwise they will not be loaded by Plone: ``` Also make sure that your add-ons do not use `zc3.autoinclude` in their `configure.zcml` -configuration file. +configuration file. Instead, list the packages to include in your add-on's +configure.zcml` explicitly: + +``` +... + + +... +``` Now build your new image: From 6bf523129c45747416ce16d00e8756b4f3a571e0 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 12 Sep 2022 10:13:54 +0000 Subject: [PATCH 03/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a930544..a1eb97b 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ points declared in `setup.py` — otherwise they will not be loaded by Plone: Also make sure that your add-ons do not use `zc3.autoinclude` in their `configure.zcml` configuration file. Instead, list the packages to include in your add-on's -configure.zcml` explicitly: +`configure.zcml`, explicitly: ``` ... From 0494ad2db3fe2833eb6068eb8de307825e4bb82d Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 12 Sep 2022 10:13:58 +0000 Subject: [PATCH 04/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a1eb97b..094b39c 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,7 @@ Also make sure that your add-ons do not use `zc3.autoinclude` in their `configur configuration file. Instead, list the packages to include in your add-on's `configure.zcml`, explicitly: -``` +```xml ... From 8c2fd0dcfb1533bf369145f0fedf44858078f814 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Sun, 2 Oct 2022 22:08:50 +0000 Subject: [PATCH 05/12] Create 67.bugfix --- news/67.bugfix | 1 + 1 file changed, 1 insertion(+) create mode 100644 news/67.bugfix diff --git a/news/67.bugfix b/news/67.bugfix new file mode 100644 index 0000000..b9324a2 --- /dev/null +++ b/news/67.bugfix @@ -0,0 +1 @@ +* Document notes on how to ensure addons load within the Plone backend container [Rudd-O] From 76e0238c49c03948edc56ebefc09bedca383af24 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Sun, 2 Oct 2022 22:09:12 +0000 Subject: [PATCH 06/12] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 094b39c..817b99e 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,6 @@ Now build your new image: ```shell docker build . -t myproject:latest -f Dockerfile -# buildah build works too ``` And start a container with From 3a00411605782c66c8e34b165102248d9cd452cc Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:52:58 +0000 Subject: [PATCH 07/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 817b99e..4c96972 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ Make sure any Plone add-ons you are adding via `pip install` have their correspo points declared in `setup.py` — otherwise they will not be loaded by Plone: ``` -... +# ... entry_points=""" [z3c.autoinclude.plugin] target = plone From 909a84a27276b9857d015ddbc57850cb9c65c2db Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:53:04 +0000 Subject: [PATCH 08/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c96972..ffbafbf 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ points declared in `setup.py` — otherwise they will not be loaded by Plone: [z3c.autoinclude.plugin] target = plone """, -... +# ... ``` From d2a1f5f2935c7a7ed57e2594761f86ba2e52aa36 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:53:10 +0000 Subject: [PATCH 09/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ffbafbf..ba91378 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,6 @@ configuration file. Instead, list the packages to include in your add-on's ... -... ``` Now build your new image: From a47053fe296c4a2f496fac84103e67a3da29c908 Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:53:25 +0000 Subject: [PATCH 10/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ba91378..a5f65be 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,6 @@ configuration file. Instead, list the packages to include in your add-on's `configure.zcml`, explicitly: ```xml -... ``` From ce1e5e16dfe43e02ff30de9c417869abe1f192fa Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:53:33 +0000 Subject: [PATCH 11/12] Update README.md Co-authored-by: Steve Piercy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a5f65be..0033fa8 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ RUN ./bin/pip install "relstorage==3.4.5" "psycopg2==2.9.3 --use-deprecated lega Make sure any Plone add-ons you are adding via `pip install` have their corresponding entry points declared in `setup.py` — otherwise they will not be loaded by Plone: -``` +```python # ... entry_points=""" [z3c.autoinclude.plugin] From ede17ae2cf1f3abccad90fee78b30b78effe51dd Mon Sep 17 00:00:00 2001 From: Rudd-O Date: Mon, 10 Oct 2022 14:53:39 +0000 Subject: [PATCH 12/12] Update news/67.bugfix Co-authored-by: Steve Piercy --- news/67.bugfix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/news/67.bugfix b/news/67.bugfix index b9324a2..d6c3a6f 100644 --- a/news/67.bugfix +++ b/news/67.bugfix @@ -1 +1 @@ -* Document notes on how to ensure addons load within the Plone backend container [Rudd-O] +* Document notes on how to ensure add-ons load within the Plone backend container [Rudd-O]