Windows build docs and tweaks

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,11 @@ Enter `[N/A]` in the box, if an item is not applicable to your change.
 Before we can approve your change; please submit the following in a comment:
 - [ ] Example configuration file for the change
 - [ ] Debug log output from testing the change
-<!-- Invoke Fluent Bit and Valgrind as: $ valgrind ./bin/fluent-bit <args> -->
+<!--  
+Please refer to the Developer Guide for instructions on building Fluent Bit with Valgrind support: 
+https://github.com/fluent/fluent-bit/blob/master/DEVELOPER_GUIDE.md#valgrind
+Invoke Fluent Bit and Valgrind as: $ valgrind --leak-check=full ./bin/fluent-bit <args>
+-->
 - [ ] Attached [Valgrind](https://valgrind.org/docs/manual/quick-start.html) output that shows no leaks or memory corruption was found
 
 If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

.github/workflows/call-build-windows.yaml

@@ -1,6 +1,16 @@
 ---
 name: Reusable workflow to build Windows packages optionally into S3 bucket
 
+#
+# If you change dependencies etc here, please also check and update
+# the other Windows build resources:
+#
+# - DEVELOPER_GUIDE.md "Windows" section
+# - appveyor.yml
+# - .github/workflows/call-build-windows.yaml
+# - dockerfiles/Dockerfile.windows
+#
+
 on:
   workflow_call:
     inputs:
@@ -127,13 +137,18 @@ jobs:
           C:\vcpkg\vcpkg install --recurse openssl --triplet ${{ matrix.config.vcpkg_triplet }}
         shell: cmd
 
+      - name: Build libyaml with vcpkg
+        run: |
+          C:\vcpkg\vcpkg install --recurse libyaml --triplet ${{ matrix.config.vcpkg_triplet }}
+        shell: cmd
+
       - name: Build Fluent Bit packages
         # If we are using 2.0.* or earlier we need to exclude the ARM64 build as the dependencies fail to compile.
         # Trying to do via an exclude for the job triggers linting errors.
         # This is only supposed to be a workaround for now so can be easily removed later.
         if: ${{ matrix.config.arch != 'amd64_arm64' || needs.call-build-windows-get-meta.outputs.armSupported == 'true' }}
         run: |
-          cmake -G "NMake Makefiles" -DFLB_NIGHTLY_BUILD='${{ inputs.unstable }}' -DOPENSSL_ROOT_DIR='${{ matrix.config.openssl_dir }}' ${{ matrix.config.cmake_additional_opt }} ../
+          cmake -G "NMake Makefiles" -DFLB_NIGHTLY_BUILD='${{ inputs.unstable }}' -DOPENSSL_ROOT_DIR='${{ matrix.config.openssl_dir }}' ${{ matrix.config.cmake_additional_opt }} -DFLB_LIBYAML_DIR=C:\vcpkg\packages\libyaml_${{ matrix.config.vcpkg_triplet }} ../
           cmake --build .
           cpack
         working-directory: build

.github/workflows/call-run-integration-test.yaml

@@ -228,7 +228,7 @@ jobs:
           bats-version: 1.9.0
 
       - name: Create k8s Kind Cluster
-        uses: helm/kind-action@v1.5.0
+        uses: helm/kind-action@v1.7.0
         with:
           node_image: kindest/node:${{ matrix.k8s-release }}
           cluster_name: kind

.github/workflows/call-test-images.yaml

@@ -182,7 +182,7 @@ jobs:
           ref: ${{ inputs.ref }}
 
       - name: Create k8s Kind Cluster
-        uses: helm/kind-action@v1.5.0
+        uses: helm/kind-action@v1.7.0
 
       - name: Set up Helm
         uses: azure/[email protected]

.github/workflows/pr-image-tests.yaml

@@ -15,24 +15,43 @@ jobs:
     pr-image-tests-build-images:
       name: PR - Buildkit docker build test
       runs-on: ubuntu-latest
-      environment: pr
+      permissions:
+        contents: read
+        # We do not push and this allows simpler workflow running for forks too
       steps:
         - name: Checkout code
           uses: actions/checkout@v3
 
         - name: Set up Docker Buildx
           uses: docker/setup-buildx-action@v2
 
+        - name: Extract metadata from Github
+          id: meta
+          uses: docker/metadata-action@v4
+          with:
+            images: ${{ github.repository }}/pr-${{ github.event.pull_request.number }}
+            tags: |
+              type=sha
+
         - name: Build the multi-arch images
+          id: build
           uses: docker/build-push-action@v4
           with:
             file: ./dockerfiles/Dockerfile
             context: .
             platforms: linux/amd64
             target: production
             push: false
-            load: false
+            load: true
+            tags: ${{ steps.meta.outputs.tags }}
+            labels: ${{ steps.meta.outputs.labels }}
 
+        - name: Sanity check it runs
+          # We do this for a simple check of dependencies
+          run: |
+            docker run --rm -t ${{ steps.meta.outputs.tags }} --help
+          shell: bash
+
         - name: Build the debug multi-arch images
           uses: docker/build-push-action@v4
           with:
@@ -46,7 +65,8 @@ jobs:
     pr-image-tests-classic-docker-build:
       name: PR - Classic docker build test
       runs-on: ubuntu-latest
-      environment: pr
+      permissions:
+        contents: read
       steps:
       - name: Checkout code
         uses: actions/checkout@v3

.github/workflows/pr-lint.yaml

@@ -22,7 +22,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ludeeus/action-shellcheck@master
         with:
-          ignore_paths: lib plugins tests
+          ignore_paths: cmake/sanitizers-cmake lib plugins tests
 
   actionlint-pr:
     runs-on: ubuntu-latest

.github/workflows/pr-package-tests.yaml

@@ -17,7 +17,6 @@ jobs:
     if: contains(github.event.pull_request.labels.*.name, 'ok-package-test')
     name: Get metadata to add to build
     runs-on: ubuntu-latest
-    environment: unstable
     outputs:
       date: ${{ steps.date.outputs.date }}
     permissions:
@@ -38,7 +37,6 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       build-matrix: ${{ steps.set-matrix.outputs.build-matrix }}
-    environment: pr
     permissions:
       contents: read
     steps:
@@ -61,7 +59,6 @@ jobs:
       version: pr-${{ github.event.number }}
       ref: ${{ github.ref }}
       build_matrix: ${{ needs.pr-package-test-build-generate-matrix.outputs.build-matrix }}
-      environment: pr
       unstable: ${{ needs.pr-package-test-build-get-meta.outputs.date }}
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
@@ -74,7 +71,6 @@ jobs:
     with:
       version: pr-${{ github.event.number }}
       ref: ${{ github.ref }}
-      environment: pr
       unstable: ${{ needs.pr-package-test-build-get-meta.outputs.date }}
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
@@ -87,7 +83,6 @@ jobs:
     with:
       version: pr-${{ github.event.number }}
       ref: ${{ github.ref }}
-      environment: pr-package-test
       unstable: ${{ needs.pr-package-test-build-get-meta.outputs.date }}
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-windows-build.yaml

@@ -1,5 +1,16 @@
 name: PR - Windows checks
+
+#
+# Test PRs on Windows
+#
+# This won't run automatically on PRs from untrusted repos, it must be approved
+# manually. If PR authors want to run it themselves, they should enable running
+# actions on their fork, then invoke it on their branch via their forked repo's
+# Actions tab.
+#
+
 on:
+  # Enable invocation via Github repo Actions tab
   workflow_dispatch:
 
   pull_request: