Merge pull request #17 from ModeSevenIndustrialSolutions/update-test-…

…yaml

Chore: Remove unused/commented code in test.yaml

.github/workflows/test.yaml

@@ -14,15 +14,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      # - name: "Set GitHub Action path"
-      #   run: |
-      #     # Write GITHUB_ACTION_PATH to GITHUB_PATH
-      #     echo "GITHUB_ACTION_PATH: $GITHUB_ACTION_PATH"
-      #     echo "$GITHUB_ACTION_PATH" >> "$GITHUB_PATH"
-      #   shell: bash
-      #   env:
-      #     GITHUB_ACTION_PATH: ${{ github.action_path }}
-
       - name: "Upload test file to Nexus"
         id: nexus-upload
         # ToDo: change/update the line below when testing is completed
@@ -33,8 +24,8 @@ jobs:
           nexus_password: ${{ secrets.nexus_password }} # Repository secret
           nexus_repository: testing
           upload_directory: files
-          filename_suffix: .txt  # Optionally matches files with text as suffix
-          testing: true          # Optionally creates upload directory and file
+          filename_suffix: .txt # Optionally matches files with text as suffix
+          testing: true # Optionally creates upload directory and file
           # Not implemented
           # repository_format: raw
 

README.md

@@ -24,7 +24,7 @@ machine [nexus-server]
   password [nexus-password]
 ```
 
-*IMPORTANT NOTE: respect the indentation of the second and third lines in the example above*
+*NOTE: respect the indentation of the second and third lines in the example above*
 
 A local folder containing the files to upload is mandatory. If no file extensions are specified,
 then the default behaviour is wildcard (\*) file matching. You can prevent this, by specifying
@@ -45,9 +45,9 @@ a file suffix/extension restricting the files to be uploaded to a subset of the
 - filename_suffix
 - testing
 
-When testing is set to "true", the upload directory and a sample TXT file with a date/time stamp
-will automatically be created for upload. This prevents the need to create test data or add files
-directly to this repository.
+When testing is set to "true" an upload directory and sample text file (with a date/time stamp)
+will automatically be created. This prevents the need to create test data or add files directly
+to your repository when testing the action.
 
 <!--
   # May be superfluous parameter
@@ -68,12 +68,11 @@ An example workflow has been provided that can be invoked on demand:
 
 ### Further Testing
 
-A shell script has also been provided, along with a  setup file. The shell script acts as
+A shell script has also been provided, along with a setup file. The shell script acts as
 a thin wrapper, extracting the functional shell code from the YAML file, then running it.
-The supplementary setup file provides some required parameters and generates a test folder
-containing a text file to upload. You still need to create a .netrc file to configure the
-environment with the nexus server name and user credentials providing write access to the
-remote repository.
+The supplementary setup file provides the required parameters that would otherwise be
+pass as inputs by a workflow. You still need to create a .netrc file to configure the
+environment with the nexus server and credentials providing write access to the repository.
 
 <!--
 [comment]: # SPDX-License-Identifier: Apache-2.0