From 7ee3e77927bb8729c1cc17d07db1f872fd107b16 Mon Sep 17 00:00:00 2001 From: Alex Rubinsteyn Date: Thu, 18 Jun 2026 15:30:04 -0400 Subject: [PATCH] Fix stale RELEASING.md: deploy.sh (build+twine), not setup.py sdist upload The release steps referenced a deleted setup.py, an obsolete pandoc/pypandoc readme step, and `python setup.py sdist upload` (deprecated; PyPI rejects it). Update to the real process: bump datacache/version.py, then ./deploy.sh (lint + test + build + twine upload). --- RELEASING.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 5a9e7ee..122a3ab 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,8 +1,14 @@ # Releasing Datacache -This document explains what do once your [Pull Request](https://www.atlassian.com/git/tutorials/making-a-pull-request/) has been reviewed and all final changes applied. Now you're ready merge your branch into master and release it to the world: +This document explains what to do once your [Pull Request](https://www.atlassian.com/git/tutorials/making-a-pull-request/) has been reviewed and all final changes applied. Now you're ready to merge your branch into master and release it to the world: -0. Make sure that you have `pandoc` and `pypandoc` installed: this is needed for readme markdown on PyPI. (See [here](http://pandoc.org/installing.html) and [here](https://pypi.python.org/pypi/pypandoc), respectively, for instructions.) -1. Bump the [version](http://semver.org/) in `setup.py`, as part of the PR you want to release. +1. Bump the [version](http://semver.org/) in `datacache/version.py`, as part of the PR you want to release. 2. Merge your branch into master. -3. Run `python setup.py sdist upload`, which pushes the newest release to PyPI. \ No newline at end of file +3. From a clean `master`, run `./deploy.sh`. It lint-checks, runs the tests, builds the + `sdist`/`wheel` with [`build`](https://pypi.org/project/build/), and uploads them to + PyPI with [`twine`](https://pypi.org/project/twine/). You'll need PyPI upload + credentials configured (e.g. in `~/.pypirc` or via `TWINE_USERNAME`/`TWINE_PASSWORD`). + +> **Note:** `python setup.py sdist upload` is deprecated and no longer works — PyPI +> rejects uploads from `setup.py`, and the project has moved to `pyproject.toml` (there +> is no `setup.py`). Always release via `./deploy.sh` (i.e. `build` + `twine`).