Prepare repo for use #4
Conversation
mjwolf
force-pushed
the
test-builds
branch
2 times, most recently
from
c54c63c
to
12c98f1
Compare
.gitignore
Outdated
| # .a files should not be committed by users; automation will build and commit | ||
| # changes in PR branches. | ||
| *.a |
There was a problem hiding this comment.
I guess these .a files have to be committed? 😬
There was a problem hiding this comment.
yes, they do. quark is a C library, and the .a files are the compiled version of it. For Go modules, including the compiled lib is standard, see https://github.com/richardwilkes/unison/tree/main/internal/skia and https://github.com/periph/d2xx/tree/main/third_party.
The only other alternative would be to have the users of the Go library compile the C code themselves, which would mean all users would need to set up a C toolchain and build system, and it would just be much more difficult for anyone to use this
bin/go.mod
Outdated
|
|
||
| go 1.22 | ||
|
|
||
| replace github.com/elastic/go-quark => ../ |
There was a problem hiding this comment.
FYI if we're expecting folks to go install this repo, this won't work - see also StyraInc/regal#490
We shouldn't need this replace at all? I'm not sure we need an additional module here, but could instead have folks install i.e. via
go install github.com/elastic/go-quark/bin@latest
# preferably
go install github.com/elastic/go-quark/cmd/quark@latest
There was a problem hiding this comment.
thanks, I didn't know that.
These files were moved from a different directory structure, and not actually working yet, but that will help me to get it working
There was a problem hiding this comment.
We can forego the binary under bin, this was basically just a test thing I had to get things going, in the future I might clean-up and make it usable, the "actual" exported quark-mon is in C and it's here: https://elastic.github.io/quark/quark-mon.8.html
https://github.com/elastic/quark/blob/main/quark-mon.c
So I'd leave the bin/quak-mon.go outside the build system in this repository
There was a problem hiding this comment.
I've removed quark-mon.go for now
Prepare the repo for use by:
Note on the build system:
To build a usable Go module, which doesn't require users to compile C code before themselves, compiled libquark artifacts are included in the published Go module. These files must be compiled by CI machines. In order to enforce this, any commits with modified .a files will have an automated commit overwrite these changes with files compiled by CI machines, so any merged PRs only contain .a files created by build machines.