diff options
| author | Jelle Zijlstra <jelle.zijlstra@gmail.com> | 2022-02-14 10:07:31 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-14 10:07:31 -0800 |
| commit | 1cb25b85dc8ddfb818923531bbaf1d1978715daa (patch) | |
| tree | 9bb3db1ce96cbd7c5cd5846488ebf2bc1ff26ca4 | |
| parent | b5dadf11d324e6302d1ca8cbfbdc8c8112189b14 (diff) | |
| download | typing-1cb25b85dc8ddfb818923531bbaf1d1978715daa.tar.gz | |
Improve release instructions (#1078)
This is what I've actually been doing, but better to document it.
| -rw-r--r-- | CONTRIBUTING.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f76b51d..63c5034 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,11 +30,17 @@ backwards-incompatible changes. - Ensure that GitHub Actions reports no errors. -- Update the version number in `pyproject.toml`. +- Update the version number in `typing_extensions/pyproject.toml` and in + `typing_extensions/CHANGELOG`. + +- Make sure your environment is up to date + + - `git checkout master` + - `git pull` + - `python -m pip install --upgrade build twine` - Build the source and wheel distributions: - - `python -m pip install --upgrade build` - `cd typing_extensions` - `rm -rf dist/` - `python -m build .` @@ -42,4 +48,8 @@ backwards-incompatible changes. - Install the built distributions locally and test (if you were using `tox`, you already tested the source distribution). -- Make sure twine is up to date, then run `twine upload dist/*`. +- Run `twine upload dist/*`. + +- Tag the release. The tag should be just the version number, e.g. `4.1.1`. + +- `git push --tags` |