Merge pull request #3 from kentik/zs-newBuild

Update libkflow to v2.5.1

Author: zaiquirii

.github/workflows/build.yml

@@ -8,17 +8,18 @@ jobs:
   golang:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: "1.17.13"
+          cache: false
       - run: patch -d go -p1 < go-runtime.patch
       - run: bash ./make.bash
         working-directory: go/src
       - run: tar -czf golang.tar.gz go
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: golang.tar.gz
           path: golang.tar.gz
@@ -38,15 +39,15 @@ jobs:
             goos:   linux
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           submodules: true
       - uses: ./.github/actions/setup-xcc
         with:
           target:  ${{ matrix.target }}
           version: f9cb5162
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: golang.tar.gz
       - run: tar -xzf golang.tar.gz -C /opt
@@ -65,7 +66,7 @@ jobs:
         env:
           TARGET: ${{ matrix.target }}
           OUTPUT: ${{ matrix.goos }}-${{ matrix.goarch }}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: libkflow-${{ matrix.target }}.a
           path: libkflow-${{ matrix.target }}.a
@@ -74,10 +75,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           path: artifacts
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7
         with:
           script: |
             const version = context.sha.substring(0, 8);
@@ -91,7 +92,7 @@ jobs:
 
             core.setOutput('version', version);
         id: create-tag
-      - uses: softprops/action-gh-release@v1
+      - uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ steps.create-tag.outputs.version }}
           files: artifacts/**/*

README.md

@@ -0,0 +1,21 @@
+# MUSL-libkflow
+
+Since libkflow uses CGO internally, we need to build it with a musl c compiler to 
+satisfy our end goal of producing a single statically linked kprobe binary. 
+Unfortunately, creating static libraries in GO with CGO enabled only works with a
+patched version of Go. 
+
+## Creating a new version of libkflow
+
+This guide assumes that you want to build the latest version of libkflow as it exists
+on the `main` branch of the `libkflow` repository. 
+
+### The Steps
+- Update the `libkflow` submodule to the latest version
+```shell
+git submodule update --remote libkflow
+git add .
+git commit -m "Update libkflow to $LATEST_VERSION"
+```
+- Push the changes to github, and the builder will take care of the rest. 
+- One can find the built libraries in the output of the github action.