lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

go.mod,README.md: add caution about unstable API

Browse Source 
Since Git LFS is only intended to be utilized as a compiled
binary and as we do not provide any guarantee of a stable API
or ABI, add notes this effect in go.mod and our main README.
This commit is contained in:
Chris Darroch 2021-08-15 20:54:07 -07:00
parent 5f42c095cb
commit ada2024b12
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -161,6 +161,12 @@ know in an issue, and we'll definitely try to help or get it fixed.
Git LFS maintains a list of currently known limitations, which you can find and
edit [here](https://github.com/git-lfs/git-lfs/wiki/Limitations).
Git LFS source code utilizes Go modules in its build system, and therefore this
project contains a `go.mod` file with a defined Go module path. However, we
do not maintain a stable Go language API or ABI, as Git LFS is intended to be
used solely as a compiled binary utility. Please do not import the `git-lfs`
module into other Go code and do not rely on it as a source code dependency.
## Need Help?
You can get help on specific commands directly:

2
go.mod
View File

@ -1,3 +1,5 @@
// The Git LFS project does not maintain a stable API or ABI for this module.
// Please do not import this module outside of the Git LFS project.
module github.com/git-lfs/git-lfs/v2
require (