Skip to content

Commit 8764d81

Browse files
committed
Add note about apply API changes to README
1 parent 52645c6 commit 8764d81

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,18 @@ if err := gitdiff.NewApplier(code).ApplyFile(&output, files[0]); err != nil {
3636

3737
## Development Status
3838

39-
Mostly complete. API changes are possible, particularly for patch application,
40-
but I expect the parsing interface and types to remain stable.
41-
42-
Patch parsing and strict application are well-covered by unit tests and the
43-
library is used in a production application that parses and applies thousands of
44-
patches every day, but the space of all possible patches is large, so there are
45-
likely undiscovered bugs.
46-
47-
The parsing code has also had a modest amount of fuzz testing. I hope to continue
48-
this testing in the future.
39+
The parsing API and types are complete and I expect will remain stable. As of
40+
March 2022, I am refactoring the apply API to address existing issues and to
41+
support non-strict application. Version 0.6.1 is the last release using the old
42+
API and the `master` branch may contain breaking changes. Please use a release
43+
version to avoid surprises.
44+
45+
Parsing and strict application are well-covered by unit tests and the library
46+
is used in a production application that parses and applies thousands of
47+
patches every day. However, the space of all possible patches is large, so
48+
there are likely undiscovered bugs.
49+
50+
The parsing code has also had a modest amount of fuzz testing.
4951

5052
## Why another git/unified diff parser?
5153

0 commit comments

Comments
 (0)