Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0698864

Browse filesBrowse files
committed
docs(MIGRATION) Note version() returning Version
1 parent ad0fb76 commit 0698864
Copy full SHA for 0698864

File tree

Expand file treeCollapse file tree

1 file changed

+19
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+19
-0
lines changed

‎MIGRATION

Copy file name to clipboardExpand all lines: MIGRATION
+19Lines 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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.