feat: adding the ability to not fail if the file is not found (#22)

.github/workflows/test.yml

@@ -53,4 +53,16 @@ jobs:
           echo "${{ steps.test-nodes.outputs.var_1 }}"
           echo "${{ steps.test-nodes.outputs.var_2 }}"
           echo "${{ steps.test-nodes.outputs.var_3 }}"
-          echo "${{ steps.test-nodes.outputs.var_4__var_1__var_2 }}"
+          echo "${{ steps.test-nodes.outputs.var_4__var_1__var_2 }}"
+      - uses: ./
+        name: Test File Not Found, expect no failure
+        id: test-file-not-found  # By default the action fails if the file is not found, test that it does not fail when instructed
+        with:
+          file-path: '.github/not-found-test-file.yaml'
+          fail-on-file-not-found: false
+      - uses: ./
+        name: Test File Not Found, expect failure
+        id: test-file-not-found-fail
+        with:
+          file-path: '.github/not-found-test-file.yaml'
+        continue-on-error: true

README.md

@@ -40,6 +40,10 @@ Default: all the nodes in the file will be used.
 
 **Optional** It controls whether outputs are exported as environment variables or not. Default: true.
 
+### `fail-on-file-not-found`
+
+**Optional** It controls whether the action should fail if the `file-path` is found or not.  Default: true.
+
 ## Outputs 📜
 This action generates one output parameter for each key in the flattened YAML file. The name of each output parameter is the concatenation of the flattened key and the separator.
 

action.yml

@@ -24,6 +24,11 @@ inputs:
     description: 'Export outputs as environment variables'
     default: true
 
+  fail-on-file-not-found:
+    required: false
+    description: 'Set to false if you do not want the action to fail if the file does not exist'
+    default: true
+
 runs:
   using: 'node16'
   main: 'dist/index.js'

src/main.ts

@@ -8,9 +8,23 @@ try {
   const separator = core.getInput('separator')
   const node = core.getInput('node')
   const exportEnvVariables = core.getBooleanInput('export-env-variables')
+  const failOnFileNotFoundInput = core.getInput('fail-on-file-not-found', {
+    required: false
+  })
+  const failOnFileNotFound =
+    failOnFileNotFoundInput.trim().toLowerCase() === 'true'
 
-  // Read file content and parse it as YAML
-  const fileContent = fs.readFileSync(filePath, 'utf8')
+  let fileContent
+  try {
+    // Read file content and parse it as YAML
+    fileContent = fs.readFileSync(filePath, 'utf8')
+  } catch (error) {
+    if (failOnFileNotFound) throw error
+    else {
+      core.notice('file-path was not found')
+      process.exit(0)
+    }
+  }
   const yamlData: any = getYamlData(fileContent, node)
 
   // Flatten the object recursively