update doc

Author: mrodm

README.md

@@ -18,7 +18,7 @@ This module will setup all of the files and configuration needed for GitHub Acti
 
 ### hiera configuration examples
 
-This module supports configuration through hiera. 
+This module supports configuration through hiera.
 
 #### Creating an organization level Actions runner
 
@@ -53,7 +53,7 @@ github_actions_runner::instances:
 ```
 
 Note, your `personal_access_token` has to contain the `repo` permission.
-    
+
 #### Instance level overwrites
 ```yaml
 github_actions_runner::instances:
@@ -88,7 +88,7 @@ github_actions_runner::github_domain: "https://git.example.com"
 github_actions_runner::github_api: "https://git.example.com/api/v3"
 ```
 
-In addition to the runner configuration examples above, you can also configure runners 
+In addition to the runner configuration examples above, you can also configure runners
 on the enterprise level by setting a value for `enterprise_name`, for example:
 ```yaml
 github_actions_runner::ensure: present
@@ -105,6 +105,35 @@ github_actions_runner::instances:
 
 Note, your `personal_access_token` has to contain the `admin:enterprise` permission.
 
+### Update PATH used by Github Runners
+
+By default, puppet will not modify the values that the runner scripts create when
+the runner is set.
+
+In case you need to use another value of paths in the environment variable PATH,
+you can define through hiera. For example:
+
+- For all runners defined:
+  ```yaml
+  github_actions_runner::path:
+    - /usr/local/bin
+    - /usr/bin
+    - /bin
+    - /my/own/path
+  ```
+- For just a specific runner:
+  ```yaml
+  github_actions_runner::instances:
+    example_org_instance:
+      path:
+        - /usr/local/bin
+        - /usr/bin
+        - /bin
+        - /my/own/path
+      labels:
+        - self-hosted-custom
+  ```
+
 ## Limitations
 
 Tested on Debian 9 (stretch), Debian 10 (buster) and CentOS7 hosts.

manifests/init.pp

@@ -56,7 +56,7 @@
 # Optional[String], Comma separated list of hosts that should not use a proxy. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners
 #
 # * path
-# Optional[Array[String]], List of paths to be used as PATH env in the instance runner.
+# Optional[Array[String]], List of paths to be used as PATH env in the instance runner. If not defined, this file will be kept as created by the runner scripts. Default value: undef
 #
 class github_actions_runner (
   Enum['present', 'absent'] $ensure,

manifests/instance.pp

@@ -42,7 +42,8 @@
 # Optional[Array[String]], A list of costum lables to add to a runner.
 #
 # * path
-# Optional[Array[String]], List of paths to be used as PATH env in the instance runner.
+# Optional[Array[String]], List of paths to be used as PATH env in the instance runner. If not defined, this file will be kept as created
+#                          by the runner scripts. (Default: Value set by github_actions_runner Class)
 #
 define github_actions_runner::instance (
   Enum['present', 'absent']  $ensure                = 'present',