feat(#468): ✨ enable usage of github env variables within hooks (#469)

* feat: ✨ hooks support env variables

* feat: ✨

* doc: 📝 add information about using env variables

* feat: ✨ cleanup

.github/workflows/test_hooks.yml

@@ -20,6 +20,8 @@ jobs:
  uses: actions/checkout@v4
  - name: Test action step
  uses: ./ # Uses an action in the root directory
+ env:
+ MY_VAR: "bar"
  with:
  github_token: ${{ secrets.GITHUB_TOKEN }}
  source_repo_path: AndreasAugustin/template.git

README.md

@@ -374,6 +374,23 @@ E.q. for the installation phase you need to use commands like `apk add --update
 
 Schema and example for the `templatesync.yml`
 
+**Remark** It is possible to use environment variables within the github action definition usable within the command configuration, e.g.
+
+```yml
+- name: Test action step
+ uses: AndreasAugustin/actions-template-sync@v1
+ env:
+ MY_VAR: "foo" # possible to define envrionment variables
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ source_repo_path: AndreasAugustin/template.git
+ upstream_branch: main
+ is_dry_run: true
+ is_allow_hooks: true
+```
+
+Please not the double quotes within the following `prepull echo` command
+
 ```yml
 hooks:
  install:
@@ -382,7 +399,7 @@ hooks:
  - python3 --version
  prepull:
  commands:
- - echo 'hi, we are within the prepull phase'
+ - echo "hi, we are within the prepull phase ${MY_VAR}"
  - echo 'maybe you want to do adjustments on the local code'
  precommit:
  commands:

src/sync_common.sh

@@ -62,6 +62,6 @@ function cmd_from_yml_file() {
  fi
  readarray cmd_Arr < <(yq "${YML_PATH} | .[]" "${FILE_NAME}")
 
- for key in "${cmd_Arr[@]}"; do printf '%s\n' "$(${key})"; done
+ for key in "${cmd_Arr[@]}"; do echo "${key}" | bash; done
  fi
 }

templatesync.yml

@@ -3,6 +3,7 @@
 hooks:
  install:
  commands:
+ - echo "foo ${MY_VAR}"
  - echo 'hi, we are within the prepush phase'
 
  prepush: