Skip to content

Fix stale RELEASING.md (deploy.sh, not setup.py sdist upload) #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iskandr merged 1 commit into from
Jun 18, 2026
Merged

Fix stale RELEASING.md (deploy.sh, not setup.py sdist upload) #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
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`).
Loading