Merge pull request #431 from zestsoftware/reinout-document-hook-packa…

…ge-dir Document hook package dir
zestsoftware · Jul 25, 2023 · 5b7e2e1 · 5b7e2e1
2 parents e5e5e05 + dea4c08
commit 5b7e2e1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -6,6 +6,10 @@ Changelog for zest.releaser
 
 - Updated contributors list.
 
+- Documenting ``hook_package_dir`` setting for entry points (which isn't
+  needed for most entry points, btw).
+  Fixes `issue 370 <https://github.com/zestsoftware/zest.releaser/issues/370>`_.
+
 - Allowing for retry for ``git push``, which might fail because of a protected
   branch. Also displaying that possible cause when it occurs. Fixes `issue 385
   <https://github.com/zestsoftware/zest.releaser/issues/385>`_.

diff --git a/doc/source/entrypoints.rst b/doc/source/entrypoints.rst
@@ -114,6 +114,9 @@ Notes:
 * The order in which entry-point defined via installed packages are
   processed is undefined.
 
+* *If* you use an entry point defined in the package you're releasing *and*
+  your package has the code inside a ``src/`` dir, you might have to add
+  ``hook_package_dir = src`` to the ``[tool.zest-releaser]`` section.
 
 
 Comments about data dict items