From bee9af52efcdc8ef3f8485c7d43c0165527afb29 Mon Sep 17 00:00:00 2001
From: Alexander Mazuruk <a.mazuruk@samsung.com>
Date: Tue, 21 Nov 2023 17:01:42 +0100
Subject: [PATCH] More support for local action runner act

- add .actrc with detailed comments

   decisions for defaults:
   - use bind mount rather than docker cp for speed (requires cleaning
     environment and action addition)
   - remove containers and volumes after finishing - those can quickly
     build up to big sizes

- add action that sets git's safe directory to * for act runs
  git started checking if user running git and user owning repo are the
  same
  github requires containers to run as root user
  act doing docker cp takes long time but bind is quick, yet we get
  fperm issues as most people dont have root owned repo

Signed-off-by: Alexander Mazuruk <a.mazuruk@samsung.com>
---
 .actrc                                        | 27 +++++++++++++++++++
 .../action.yaml                               |  2 ++
 .../actions/git-safe-directory/action.yaml    |  9 +++++++
 3 files changed, 38 insertions(+)
 create mode 100644 .actrc
 create mode 100644 .github/actions/git-safe-directory/action.yaml

diff --git a/.actrc b/.actrc
new file mode 100644
index 00000000000000..44367d36ab8b94
--- /dev/null
+++ b/.actrc
@@ -0,0 +1,27 @@
+# This file contains settings for local github action runner act:
+# https://github.com/nektos/act
+#
+# It is recommended to run specific jobs that you need, all jobs except those
+# running on should darwin work.
+# e.g. act -j build_linux
+#
+# It is recommended to set up a separate bridge network
+# and possibly define it in  ~/.actrc like so:
+# --network=bridge
+# https://docs.docker.com/network/drivers/bridge/
+
+# Remove containers after finishing a job, comment out for debugging
+--rm
+
+# Reuse the checkout from host, otherwise act will do docker cp that makes
+# running jobs a lot longer even on SSD. Clean up your .environment before
+# running it.
+--bind
+
+# Easier to have 1:1 match between triggering jobs and reading logs when they
+# use the same name
+--log-prefix-job-id
+
+# Default runner image does not include enough.
+# https://github.com/nektos/act#default-runners-are-intentionally-incomplete
+-P ubuntu-latest=catthehacker/ubuntu:full-latest
diff --git a/.github/actions/checkout-submodules-and-bootstrap/action.yaml b/.github/actions/checkout-submodules-and-bootstrap/action.yaml
index 892cf93716cb8d..8ddaec14e7bc47 100644
--- a/.github/actions/checkout-submodules-and-bootstrap/action.yaml
+++ b/.github/actions/checkout-submodules-and-bootstrap/action.yaml
@@ -17,6 +17,8 @@ runs:
   steps:
     - name: Dump disk info
       uses: ./.github/actions/dump-disk-info
+    - name: Set git safe directory for local act runs
+      uses: ./.github/actions/git-safe-directory
     - name: Checkout submodules
       uses: ./.github/actions/checkout-submodules
       with:
diff --git a/.github/actions/git-safe-directory/action.yaml b/.github/actions/git-safe-directory/action.yaml
new file mode 100644
index 00000000000000..1308c4ea1bf524
--- /dev/null
+++ b/.github/actions/git-safe-directory/action.yaml
@@ -0,0 +1,9 @@
+name: Git safe directory
+description: For running act with checkout owned by non-root user
+runs:
+  using: "composite"
+  steps:
+    - name: Set git safe.directory to "*"
+      if: ${{ env.ACT }}
+      shell: bash
+      run: git config --system --add safe.directory '*'
\ No newline at end of file