Skip to content

Commit

Permalink
Api interface v3.21.1 (#35)
Browse files Browse the repository at this point in the history
* Generate Quobyte v3.21.1 API

and define api inter such that api can
be mocked by api user programs.

* Add build instruction to dev doc

* Fix compilation and mockgen failure

* Update to go lang to recent version
* Add missing dependency required for mockgen

* Add missing go:generate trigger to doc

* Fix code comment
  • Loading branch information
venkatsc authored May 10, 2024
1 parent 35dcef6 commit bd41bed
Show file tree
Hide file tree
Showing 6 changed files with 2,452 additions and 145 deletions.
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
to <api-rep>/quobyte/types.go
* Run `gofmt -w <api-rep>/quobyte/types.go`
* `go.mod` files must be present at the root level of the project
* Run `go build ./...` in the project root (in the parent of go.mod file) to run compilation pass
(binary is not produced but checks for possible compilation issues)
* If compilation is successful, run `go generate ./...` to generate mocks
* Each major release beyond V1 (such =v2[+].a.b) must provide unique import path such as `github.com/quobyte/api/vX`
* To get around this issue, we always use v1.x.x (**NEVER** make v2 release)
* Further, each `*.go` file must have a `package XYZ` statement as the first line and must be placed into `XZY`
Expand Down
4 changes: 3 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
module github.com/quobyte/api

go 1.14
go 1.22.2

require go.uber.org/mock v0.4.0
3 changes: 2 additions & 1 deletion go.sum
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@

go.uber.org/mock v0.4.0 h1:VcM4ZOtdbR4f6VXfiOpwpVJDL6lCReaZ6mw31wqh7KU=
go.uber.org/mock v0.4.0/go.mod h1:a6FSlNadKUHUa9IP5Vyt1zh4fC7uAwxMutEAscFbkZc=
Loading

0 comments on commit bd41bed

Please sign in to comment.