Add clarifing comments

Signed-off-by: Khosrow Moossavi <[email protected]>
terraform-docs · Jul 7, 2022 · ac2a6b5 · ac2a6b5
1 parent fefba94
commit ac2a6b5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/docker-entrypoint.sh b/src/docker-entrypoint.sh
@@ -49,7 +49,11 @@ if [ -z "${INPUT_GIT_PUSH_USER_EMAIL}" ]; then
 fi
 
 git_setup() {
+    # When the runner maps the $GITHUB_WORKSPACE mount, it is owned by the runner
+    # user while the created folders are owned by the container user, causing this
+    # error. Issue description here: https://github.com/actions/checkout/issues/766
     git config --global --add safe.directory /github/workspace
+
     git config --global user.name "${INPUT_GIT_PUSH_USER_NAME}"
     git config --global user.email "${INPUT_GIT_PUSH_USER_EMAIL}"
     git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true