Skip to content

Commit d452190

Browse files
dolfinusdolfinus
committed
Plan next major release
1 parent d2bc651 commit d452190

12 files changed

Lines changed: 43 additions & 33 deletions

‎CHANGELOG.rst‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
Changelog
22
==========
33

4-
2.2
4+
3.0
55
---
66

77
.. changelog::
8-
:version: 2.2.0
8+
:version: 3.0.0
99
:released: 15.01.2026
1010

1111
.. change::
12-
:tags: refactor,breaking
12+
:tags: breaking
1313

14-
Make most of args in ``version_from_git()`` keyword-only.
14+
Make most of args in ``version_from_git`` keyword-only.
1515

1616
.. change::
17-
:tags: refactor,breaking
17+
:tags: breaking
18+
19+
Change return type of ``version_from_git`` and ``infer_version`` from ``str`` to ``packaging.Version``
20+
21+
.. change::
22+
:tags: refactor, breaking
1823

1924
Timestamps in version templates are now timezone-aware.
2025

26+
.. change::
27+
:tags: refactor
28+
29+
Split ``setuptools_git_versioning.py`` into smaller set of files.
30+
2131
.. change::
2232
:tags: refactor
2333

‎README.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
8383
.. code:: toml
8484
8585
[build-system]
86-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
86+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
8787
build-backend = "setuptools.build_meta"
8888
8989
[tool.setuptools-git-versioning]
@@ -119,7 +119,7 @@ and then add new argument ``setuptools_git_versioning`` with config options:
119119
setuptools_git_versioning={
120120
"enabled": True,
121121
},
122-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
122+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
123123
)
124124
125125
And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):

‎docs/options/branch_formatter.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ name and return a properly formatted one:
7070

7171
setuptools.setup(
7272
...,
73-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
73+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
7474
setuptools_git_versioning={
7575
"enabled": True,
7676
"dev_template": "{branch}.dev{ccount}",
@@ -82,7 +82,7 @@ name and return a properly formatted one:
8282
.. code-tab:: toml ``pyproject.toml`` file
8383

8484
[build-system]
85-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
85+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
8686
# __legacy__ is required to have access to package
8787
# during build step
8888
build-backend = "setuptools.build_meta:__legacy__"

‎docs/options/starting_version.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can change this version by setting up ``starting_version`` option in your co
2121

2222
setuptools.setup(
2323
...,
24-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
24+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
2525
setuptools_git_versioning={
2626
"enabled": True,
2727
"starting_version": "1.0.0", # <---
@@ -31,7 +31,7 @@ You can change this version by setting up ``starting_version`` option in your co
3131
.. code-tab:: toml ``pyproject.toml`` file
3232

3333
[build-system]
34-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
34+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
3535
build-backend = "setuptools.build_meta"
3636

3737
[project]

‎docs/options/tag_formatter.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ name and return a properly formatted one:
7171

7272
setuptools.setup(
7373
...,
74-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
74+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
7575
setuptools_git_versioning={
7676
"enabled": True,
7777
"dev_template": "{tag}.dev{ccount}",
@@ -83,7 +83,7 @@ name and return a properly formatted one:
8383
.. code-tab:: toml ``pyproject.toml`` file
8484

8585
[build-system]
86-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
86+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
8787
# __legacy__ is required to have access to package
8888
# during build step
8989
build-backend = "setuptools.build_meta:__legacy__"

‎docs/runtime_version.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To resolve version number in runtime, you should move ``VERSION`` file to your m
3030
3131
setuptools.setup(
3232
...,
33-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
33+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
3434
setuptools_git_versioning={
3535
"enabled": True,
3636
"version_file": version_file,
@@ -44,7 +44,7 @@ To resolve version number in runtime, you should move ``VERSION`` file to your m
4444
.. code-tab:: toml ``pyproject.toml``
4545

4646
[build-system]
47-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
47+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
4848
build-backend = "setuptools.build_meta"
4949

5050
[project]

‎docs/schemas/callback/version_callback.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Then place it in both the branches and update your config:
4242

4343
setuptools.setup(
4444
...,
45-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
45+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
4646
setuptools_git_versioning={
4747
"enabled": True,
4848
"version_callback": get_version, # <---
@@ -52,7 +52,7 @@ Then place it in both the branches and update your config:
5252
.. code-tab:: toml ``pyproject.toml`` file
5353

5454
[build-system]
55-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
55+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
5656
# __legacy__ is required to have access to package
5757
# during build step
5858
build-backend = "setuptools.build_meta:__legacy__"
@@ -84,7 +84,7 @@ If a value of this option is not a function but just str, it also could be used:
8484

8585
setuptools.setup(
8686
...,
87-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
87+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
8888
setuptools_git_versioning={
8989
"enabled": True,
9090
"version_callback": my_module.__version__, # <---
@@ -94,7 +94,7 @@ If a value of this option is not a function but just str, it also could be used:
9494
.. code-tab:: toml ``pyproject.toml`` file
9595

9696
[build-system]
97-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
97+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
9898
# __legacy__ is required to have access to package
9999
# during build step
100100
build-backend = "setuptools.build_meta:__legacy__"

‎docs/schemas/file/dev_release_file.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Then update your config file:
4444

4545
setuptools.setup(
4646
...,
47-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
47+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
4848
setuptools_git_versioning={
4949
"enabled": True,
5050
"version_file": version_file,
@@ -57,7 +57,7 @@ Then update your config file:
5757
.. code-tab:: toml ``pyproject.toml``
5858

5959
[build-system]
60-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
60+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
6161
build-backend = "setuptools.build_meta"
6262

6363
[project]
@@ -111,7 +111,7 @@ For example, if the branch name is something like ``alpha``, ``beta``,
111111

112112
setuptools.setup(
113113
...,
114-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
114+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
115115
setuptools_git_versioning={
116116
"enabled": True,
117117
"version_file": version_file,
@@ -124,7 +124,7 @@ For example, if the branch name is something like ``alpha``, ``beta``,
124124
.. code-tab:: toml ``pyproject.toml``
125125

126126
[build-system]
127-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
127+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
128128
build-backend = "setuptools.build_meta"
129129

130130
[project]
@@ -162,7 +162,7 @@ It is also possible to use branch names like ``1.0-alpha`` or ``1.1.beta``:
162162

163163
setuptools.setup(
164164
...,
165-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
165+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
166166
setuptools_git_versioning={
167167
"enabled": True,
168168
"count_commits_from_version_file": True,
@@ -175,7 +175,7 @@ It is also possible to use branch names like ``1.0-alpha`` or ``1.1.beta``:
175175
.. code-tab:: toml ``pyproject.toml``
176176

177177
[build-system]
178-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
178+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
179179
build-backend = "setuptools.build_meta"
180180

181181
[project]

‎docs/schemas/file/version_file.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Then place it in both the branches and update your config file:
4444

4545
setuptools.setup(
4646
...,
47-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
47+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
4848
setuptools_git_versioning={
4949
"enabled": True,
5050
"version_file": version_file, # <---
@@ -54,7 +54,7 @@ Then place it in both the branches and update your config file:
5454
.. code-tab:: toml ``pyproject.toml``
5555

5656
[build-system]
57-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
57+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
5858
build-backend = "setuptools.build_meta"
5959

6060
[tool.setuptools-git-versioning]

‎docs/schemas/tag/dirty_version.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To get version in such a format you can set a template in the config file:
4141

4242
setuptools.setup(
4343
...,
44-
setup_requires=["setuptools-git-versioning>=2.0,<3"],
44+
setup_requires=["setuptools-git-versioning>=3.0,<4"],
4545
setuptools_git_versioning={
4646
"enabled": True,
4747
"dirty_template": "{tag}.post{ccount}+dirty", # <---
@@ -51,7 +51,7 @@ To get version in such a format you can set a template in the config file:
5151
.. code-tab:: toml ``pyproject.toml``
5252

5353
[build-system]
54-
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
54+
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
5555
build-backend = "setuptools.build_meta"
5656

5757
[tool.setuptools-git-versioning]

0 commit comments

Comments
 (0)