Skip to content

Commit d193ff1

Browse files
committed
quick readme with instructions on how to update the build
1 parent 861c1d5 commit d193ff1

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MUSL-libkflow
2+
3+
Since libkflow uses CGO internally, we need to build it with a musl c compiler to
4+
satisfy our end goal of producing a single statically linked kprobe binary.
5+
Unfortunately, creating static libraries in GO with CGO enabled only works with a
6+
patched version of Go.
7+
8+
## Creating a new version of libkflow
9+
10+
This guide assumes that you want to build the latest version of libkflow as it exists
11+
on the `main` branch of the `libkflow` repository.
12+
13+
### The Steps
14+
- Update the `libkflow` submodule to the latest version
15+
```shell
16+
git submodule update --remote libkflow
17+
git add .
18+
git commit -m "Update libkflow to $LATEST_VERSION"
19+
```
20+
- Push the changes to github, and the builder will take care of the rest.
21+
- One can find the built libraries in the output of the github action.

0 commit comments

Comments
 (0)