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
* Clarify version policy
We will increase the patch version after a release. The minor version is
increased when features are added.
Also, use `dev0` instead of `dev`, since the former is the normalized
version of the latter.
* Remove the 'Development version' section
* More examples and guidance
* Use consistent markup
* Apply suggestions and link to the existing policy
* Also link to the versioning policy in the first section
* Update CONTRIBUTING.md
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---------
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,14 +21,9 @@ CPython's `main` branch.
21
21
# Versioning scheme
22
22
23
23
Starting with version 4.0.0, `typing_extensions` uses
24
-
[Semantic Versioning](https://semver.org/). See the documentation
24
+
[Semantic Versioning](https://semver.org/). [See the documentation](https://typing-extensions.readthedocs.io/en/latest/#versioning-and-backwards-compatibility)
25
25
for more detail.
26
26
27
-
## Development version
28
-
After a release the version is increased once in [pyproject.toml](/pyproject.toml) and
29
-
appended with a `.dev` suffix, e.g. `4.0.1.dev`.
30
-
Further subsequent updates are not planned between releases.
31
-
32
27
# Type stubs
33
28
34
29
A stub file for `typing_extensions` is maintained
@@ -93,15 +88,18 @@ pipx run pre-commit run -a
93
88
94
89
# Workflow for PyPI releases
95
90
96
-
- Make sure you follow the versioning policy in the documentation
97
-
(e.g., release candidates before any feature release, do not release development versions)
91
+
- Make sure that the version in `pyproject.toml` and `CHANGELOG.md` follows the versioning policy outlined in
- Check that `CHANGELOG.md` accurately reflects all important changes committed to `main` since the previous release.
102
97
103
98
- Update the version number in `typing_extensions/pyproject.toml` and in
104
-
`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` for the initial release candidate
101
+
-`4.1.0rc2.dev0` → `4.1.0rc2` or `4.1.0`, depending on whether the release is a second release candidate or a full release
102
+
-`4.1.1.dev0` → `4.1.1` when making a hotfix release
105
103
106
104
- Create a new GitHub release at https://github.com/python/typing_extensions/releases/new.
107
105
Details:
@@ -111,4 +109,6 @@ pipx run pre-commit run -a
111
109
- Release automation will finish the release. You'll have to manually
112
110
approve the last step before upload.
113
111
114
-
- 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.X.X.dev, see also [Development versions](#development-version). # TODO decide on major vs. minor increase.
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