Skip to content

Commit 97f05af

Browse files
committed
docs(MIGRATION) Note version() returning Version
1 parent 688792a commit 97f05af

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

MIGRATION

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ _Notes on the upcoming release will be added here_
2424

2525
<!-- Maintainers, insert migration notes for the next release here -->
2626

27+
#### Git version handling API changes (#491)
28+
29+
- `Git.version()` now returns a `Version` object instead of a string
30+
31+
Before:
32+
```python
33+
git = Git(path=path)
34+
version_str = git.version() # returns a string like "2.43.0"
35+
```
36+
37+
After:
38+
```python
39+
git = Git(path=path)
40+
version_obj = git.version() # returns a Version object
41+
version_str = ".".join([str(x) for x in (version_obj.major, version_obj.minor, version_obj.micro)])
42+
```
43+
44+
- `GitSync.get_git_version()` continues to return a string for backward compatibility
45+
2746
#### pytest fixtures: `git_local_clone` renamed to `example_git_repo` (#468)
2847

2948
- pytest: `git_local_clone` renamed to `example_git_repo`

0 commit comments

Comments
 (0)