Update README examples and include link to 2.x to 3.x migration guide #617
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added migration instructions for upgrading from 2.x to 3.x and updated code examples to reflect the new API using `exec` instead of `GitProcess.exec`. This clarifies breaking changes and guides users on updating their code.
dscho
reviewed
Nov 11, 2025
|
|
||
| ## Migrating from 2.x to 3.x | ||
|
|
||
| See the migration guide in the [3.0.0 release](https://github.com/desktop/dugite/releases/tag/v3.0.0) for details on breaking changes and how to update your code. |
There was a problem hiding this comment.
How about linking directly to the migration guide?
Suggested change
| See the migration guide in the [3.0.0 release](https://github.com/desktop/dugite/releases/tag/v3.0.0) for details on breaking changes and how to update your code. | |
| See the [migration guide in the 3.0.0 release](https://github.com/desktop/dugite/releases/tag/v3.0.0#:~:text=Migration%20guide) for details on breaking changes and how to update your code. |
|
Thank you for your quick response and preparing the migration guide. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added migration instructions for upgrading from 2.x to 3.x and updated code examples to reflect the new API using
execinstead ofGitProcess.exec.