Skip to content

Commit 74f0b76

Browse files
committed
docs(usage): Clarify GitVersion.Core library API stability statement
1 parent 40784c7 commit 74f0b76

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/input/docs/usage/library.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@
22
Order: 40
33
Title: Library
44
Description: |
5-
Install with NuGet and use GitVersion as a software library. Although this
5+
Install with NuGet and use GitVersion.Core as a software library. Although this
66
is an unsupported option and the API may break even between minor or
77
patch releases, it's a useful option to some.
88
CardIcon: library.svg
99
RedirectFrom: docs/usage/nuget-library
1010
---
1111

12-
Install with NuGet and use GitVersion as a software library. Although this
12+
Install with NuGet and use GitVersion.Core as a software library. Although this
1313
is an unsupported option and the API may break even between minor or
1414
patch releases, it's a useful option to some.
1515

1616
:::{.alert .alert-warning}
1717
**Warning**
18-
The library API (GitVersion.Core) is not stable and does not follow the semantic versioning
19-
of the GitVersion tool. A patch release of the tool may break the library
20-
and we will refactor and change the library API without notice.
18+
The library API (GitVersion.Core) is stable, and we try to follow the semantic versioning of the GitVersion tool,
19+
but there is no real guarantee as we mainly focus on the GitVersion.Tool.
2120
:::
2221

23-
<a href="/api" class="btn btn-primary">Explore the GitVersion Core library API</a>
22+
<a href="/api" class="btn btn-primary">Explore the GitVersion.Core library API</a>

0 commit comments

Comments
 (0)