Skip to content

Commit e29b457

Browse files
committed
More examples and guidance
1 parent 0dc7b85 commit e29b457

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,18 @@ pipx run pre-commit run -a
8888

8989
# Workflow for PyPI releases
9090

91-
- Make sure you follow the versioning policy in the documentation
92-
(e.g., release candidates before any feature release, do not release development versions)
91+
- Make sure to release at least one release candidate (starting with `rc1`) before making a full release. E.g. release `4.2.0rc1` before releasing `4.2.0`.
92+
When an urgent hotfix is necessary (and you bump only the patch version), you can skip the release candidates.
9393

9494
- Ensure that GitHub Actions reports no errors.
9595

9696
- Check that `CHANGELOG.md` accurately reflects all important changes committed to `main` since the previous release.
9797

9898
- Update the version number in `typing_extensions/pyproject.toml` and in
99-
`typing_extensions/CHANGELOG.md`.
99+
`typing_extensions/CHANGELOG.md` by removing `.dev0` and potentially adding the `rcX` suffix:
100+
- `4.1.0.dev0``4.1.0rc1`
101+
- `4.1.0rc2.dev0``4.1.0rc2` or `4.1.0` when making a full release
102+
- `4.1.1.dev0``4.1.1rc1` or `4.1.1` when making an urgent hotfix
100103

101104
- Create a new GitHub release at https://github.com/python/typing_extensions/releases/new.
102105
Details:
@@ -106,4 +109,6 @@ pipx run pre-commit run -a
106109
- Release automation will finish the release. You'll have to manually
107110
approve the last step before upload.
108111

109-
- After the release has been published on PyPI upgrade the version in number in [pyproject.toml](/pyproject.toml) to a `dev` version of the next planned release. For example, change 4.1.1 to 4.1.2.dev0.
112+
- After the release has been published on PyPI upgrade the patch or rc version number in [pyproject.toml](/pyproject.toml) and append `.dev0`. For example:
113+
- 4.1.1 → 4.1.2.dev0
114+
- 4.1.1rc1 → 4.1.1rc2.dev0

0 commit comments

Comments
 (0)