You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,15 +88,18 @@ pipx run pre-commit run -a
88
88
89
89
# Workflow for PyPI releases
90
90
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.
93
93
94
94
- Ensure that GitHub Actions reports no errors.
95
95
96
96
- Check that `CHANGELOG.md` accurately reflects all important changes committed to `main` since the previous release.
97
97
98
98
- 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
100
103
101
104
- Create a new GitHub release at https://github.com/python/typing_extensions/releases/new.
102
105
Details:
@@ -106,4 +109,6 @@ pipx run pre-commit run -a
106
109
- Release automation will finish the release. You'll have to manually
107
110
approve the last step before upload.
108
111
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:
0 commit comments