docs: Updated documentation to reflect changes

Author: clivewalkden

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
 
             - name: Upload VPN logs
               if: always()
-              uses: actions/upload-artifact@v2
+              uses: actions/upload-artifact@v4
               with:
                   name: vpn-logs
-                  path: openvpn.log
+                  path: /tmp/openvpn.log

README.md

@@ -2,13 +2,14 @@
 
 The Sonassi OpenVPN Connection GitHub Action allows you to establish a secure connection to a Sonassi VPN server within your GitHub Actions workflow.
 
-To use this action, you need to provide the necessary configuration details for your Sonassi VPN server. This includes the configuration file, certificate, and certificate name. 
+To use this action, you need to provide the necessary configuration details for your Sonassi VPN server. This includes the configuration file, certificate, certificate name, and optional tmp_dir name. 
 
 ## Inputs
 
 - `config`: The config file provided in the VPN bundle for Linux. (required)
 - `certificate`: The p12 file provided in the VPN bundle for Linux. (required)
 - `certificate_name`: The p12 filename as configured inside the config file (required)
+- `tmp_dir`: The directory to save the certificate and config to defaults to `/tmp`
 
 ## Example Usage
 
@@ -19,17 +20,18 @@ To use this action, you need to provide the necessary configuration details for
         config: ${{ secrets.VPN_SERVER_CONFIG }}
         certificate: ${{ secrets.VPN_CERTIFICATE }}
         certificate_name: ${{ secrets.VPN_CERTIFICATE_NAME }}
+        tmp_dir: "/tmp"
 
 - name: Wait for VPN to connect
     if: success()
     run: until ping -c 1 -W 5 172.16.0.61; do sleep 2; done
 
 - name: Upload VPN logs
     if: always()
-    uses: actions/upload-artifact@v2
+    uses: actions/upload-artifact@v4
     with:
         name: vpn-logs
-        path: openvpn.log
+        path: /tmp/openvpn.log
 ```
 
 Make sure to store your sensitive information (such as the config, certificate, and certificate_name) as secrets in your GitHub repository to keep them secure. 

action.yml

@@ -16,7 +16,7 @@ inputs:
     default: "certificate.p12"
   tmp_dir:
     description: "The temporary directory to store the OpenVPN configuration and certificate"
-    required: true
+    required: false
     default: "/tmp"
 runs:
   using: "node20"