Document release process

[ericof]

Currently it is not possible to simply use fullrelease to make a new release, as zest.releaser does not support building with hatchling.

c/c: @mauritsvanrees

[mauritsvanrees]

@ericof Where does this fail for you?

I have just used zest.releaser to upload a release to the TEST pypi:

https://test.pypi.org/project/pas.plugins.authomatic/2.0.0b2/

Maybe you are missing some packages that would help here, or are using an older version? I am using a checkout of zest.releaser, and I see I have these versions, with Python 3.12:

build==1.2.2.post1
certifi==2024.8.30
cffi==1.17.1
charset-normalizer==3.4.0
check-manifest==0.50
cmarkgfm==2024.11.20
colorama==0.4.6
docutils==0.21.2
idna==3.10
jaraco.classes==3.4.0
jaraco.context==6.0.1
jaraco.functools==4.1.0
keyring==25.5.0
markdown-it-py==3.0.0
mdurl==0.1.2
more-itertools==10.5.0
nh3==0.2.19
packaging==24.2
pep440==0.1.2
pip==24.3.1
pkginfo==1.12.0
pycparser==2.22
Pygments==2.18.0
pyproject_hooks==1.2.0
pyroma==4.2
readme_renderer==44.0
requests==2.32.3
requests-toolbelt==1.0.0
rfc3986==2.0.0
rich==13.9.4
setuptools==75.6.0
trove-classifiers==2024.10.21.16
twine==6.0.1
urllib3==2.2.3
wheel==0.45.1

[ericof]

Error

My issue happened with the upload part of Twine:

INFO: Making a wheel of a fresh tag checkout (in /private/var/folders/v0/ccn36mkx1_78br2c44g6f9dh0000gn/T/pas.plugins.authomatic-2.0.0b1-o45d162m/gitclone).
INFO: Building wheel...

Upload to pypi (Y/n)? y
Uploading distributions to https://upload.pypi.org/legacy/
Traceback (most recent call last):
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/bin/fullrelease", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/fullrelease.py", line 27, in main
    releaser.run()
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/baserelease.py", line 429, in run
    self.execute()
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/release.py", line 102, in execute
    self._release()
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/release.py", line 343, in _release
    self._upload_distributions(package)
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/release.py", line 206, in _upload_distributions
    self._retry_twine("upload", server, files_in_dist)
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/zest/releaser/release.py", line 254, in _retry_twine
    twine_dispatch(twine_args)
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/twine/cli.py", line 123, in dispatch
    return main(args.args)
           ^^^^^^^^^^^^^^^
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/twine/commands/upload.py", line 198, in main
    return upload(upload_settings, parsed_args.dists)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/twine/commands/upload.py", line 124, in upload
    _make_package(filename, signatures, upload_settings) for filename in uploads
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/twine/commands/upload.py", line 77, in _make_package
    package = package_file.PackageFile.from_filename(filename, upload_settings.comment)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/ericof/Projects/Plone/Collective/pas.plugins.authomatic/.venv/lib/python3.12/site-packages/twine/package.py", line 117, in from_filename
    raise exceptions.InvalidDistribution(
twine.exceptions.InvalidDistribution: Metadata is missing required fields: Name, Version.
Make sure the distribution includes the files where those fields are specified, and is using a supported Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2.

Versions

• zest.releaser 9.1.3
• Build version is older than yours (1.0.3)
• Twine version is older than yours (4.0.2)

Next steps

I will try to clean up my environment and see if I get newer versions of Build and Twine, as this could be the issue.

[ericof]

Update: Twine and Build were pinned on https://dist.plone.org/release/6.0.13/constraints.txt. I will upgrade to https://dist.plone.org/release/6.0.14/constraints.txt and see if I get better results

[mauritsvanrees]

Try zest.releaser 9.2.0. It has this in the changelog:

- Build distributions in an isolated environment.
  Otherwise `build` cannot install packages needed for the build system, for example `hatchling`.
  Fixes `issue 448 <https://github.com/zestsoftware/zest.releaser/issues/448>`_.
  [maurits]