Skip to content

How to make a release

Jump to bottom
Konstantinos Tsilimparis edited this page Mar 25, 2026 · 32 revisions

Local steps

  1. Bump version: Edit pyproject.toml, e.g., change version = "1.1.2" to version = "1.2.0" (or whatever the new version is).

  2. Edit CHANGES file: Add major changes, minor changes and bug fixes.

  3. Run python render_citation.py to generate the list of contributors: This list is generated in the CITATION.cff file which is then used by Zenodo and Github to create citations. The contributors include everyone who has contributed since the beginning, and they are ordered by how many lines of code each person has added, from most to least. For known contributors we add the affiliations too.

Screenshot 2026-03-24 170015



GitHub steps: GitHub release, website, Zenodo

  1. Merge dev to master and then master back to dev.

  2. This merge to master _triggers _the webhook and rebuilds the stable website.

  3. Create a GitHub Release: Here you can create a new tag that matches the released version (e.g., v1.2.0). Then paste the contents of the CHANGES file there too.

  4. This release triggers Zenodo, which creates a new publication.


PyPI steps

  1. Build the Python package: Run pip install build and then python -m build. This creates dist/pcntoolkit-1.2.0.tar.gz and dist/pcntoolkit-1.2.0-py3-none-any.whl

  2. Upload to PyPI: Run pip install twine and then twine upload dist/*1.2.0*. It will ask for your user's API token. To make one, go to your PyPI account settings and generate one, then create a file in $HOME/.pypirc ($HOME/ is C:/Users/user in Windows) and add the token in there:

[pypi]

username = __token__

password = <add your token here>

Note that when you upload, it is automatically checked what the package is in the .toml file and PyPI uploads it in the right project (in this case the pcntoolkit PyPI project)

Clone this wiki locally