Release pylxd 2.4.0 (#716)

Author: simondeziel

doc/source/contributing.rst

@@ -35,6 +35,57 @@ The main steps are:
 6. At regular intervals the pyLXD module will be released to PyPi with the new
    features and bug fixes.
 
+Releasing
+---------
+
+New versions of pyLXD are published to `PyPI <https://pypi.org/project/pylxd/>`_.
+
+1. Bump the version in ``pyproject.toml``::
+
+       [project]
+       name = "pylxd"
+       version = "<version>"
+       ...
+
+   Submit that change in a PR and get it merged.
+
+2. Install the release tooling into a virtual environment (once):
+
+   .. code-block:: console
+
+       python3 -m venv .venv-release
+       source .venv-release/bin/activate
+       pip install '.[release]'
+
+3. Build the source and wheel archives:
+
+   .. code-block:: console
+
+       python3 -m build
+
+   This produces both ``dist/pylxd-<version>.tar.gz`` and
+   ``dist/pylxd-<version>-py3-none-any.whl``.
+
+4. Verify the archives:
+
+   .. code-block:: console
+
+       twine check --strict dist/*
+
+   Both artifacts should report ``PASSED``.
+
+5. Upload to PyPI:
+
+   .. code-block:: console
+
+       twine upload dist/*
+
+   After a successful upload the new release is visible at
+   https://pypi.org/project/pylxd/.
+
+6. Create a new release and tag on GitHub using the autogenerated release notes
+   from the merged PRs.
+
 Requirements to merge a Pull Request (PR)
 -----------------------------------------
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pylxd"
-version = "2.3.9"
+version = "2.4.0"
 description = "Python library for interacting with the LXD REST API"
 readme = { file = "README.rst", content-type = "text/x-rst" }
 requires-python = ">=3.10"
@@ -43,6 +43,7 @@ testing = [
 format = ["black", "flake8", "flake8-pyproject", "isort"]
 check = ["mypy"]
 doc = ["Sphinx"]
+release = ["build", "twine>=6.0.0"]
 
 [tool.setuptools.packages.find]
 include = ["pylxd*"]