updated tests and documentation

Author: logyball

README.md

@@ -4,15 +4,25 @@ This action locates one of a given list of labels in the labels active on the wo
 
 ## Inputs
 
+While `allowed` and `allowed_multiple` are both optional, at least one of either is required.
+
 ### `allowed`
 
-**Required** The labels to look for. Separate via commas or newlines (using a block string).
+**Optional** The labels to look for to match exactly one of. Separate via commas or newlines (using a block string).
+
+### `allowed_multiple`
+
+**Optional** The labels to look for to match many of. Separate via commas or newlines (using a block string).
+
+### `default_match`
+
+**Optional** A value to return if no matching labels are found.  If this value is not specified and no matching labels are found, this action will exit with a failing code.
 
 ## Outputs
 
 ### `match`
 
-The one label from the `allowed` list that was located. The action will fail if no labels matched or more than one was found.
+The one label from the `allowed` or `allowed_multiple` list that was located.  If no `default_match` is specified, the action will fail if no labels matched or more than one was found.
 
 ## Example usage
 

dist/index.js

@@ -13,14 +13,23 @@ function parseAllowed(allowed) {
   )
 }
 
-function findMatching(labelNames, allowedLabels, isMultipleAllowed, defaultValue) {
+function findMatching(
+  labelNames,
+  allowedLabels,
+  isMultipleAllowed,
+  defaultMatch
+) {
   const allowedLabelsSet = new Set(allowedLabels)
   const matchingLabels = labelNames.filter((labelName) =>
     allowedLabelsSet.has(labelName)
   )
-  if ( matchingLabels.length === 0 && defaultValue !== undefined) {
-    return [defaultValue]
+  if (
+    matchingLabels.length === 0 &&
+    (defaultMatch !== undefined || defaultMatch === '')
+  ) {
+    return [defaultMatch]
   }
+
   if (
     isMultipleAllowed
       ? matchingLabels.length === 0
@@ -25656,7 +25665,12 @@ function run() {
     const defaultMatch = core.getInput('default_match')
     let matchingLabel
     if (allowedLabels.length > 0) {
-      matchingLabel = match.findMatching(labelNames, allowedLabels, false, defaultMatch)
+      matchingLabel = match.findMatching(
+        labelNames,
+        allowedLabels,
+        false,
+        defaultMatch
+      )
     } else if (allowedMultipleLabels.length > 0) {
       matchingLabel = match.findMatching(
         labelNames,

index.js

@@ -14,7 +14,12 @@ function run() {
     const defaultMatch = core.getInput('default_match')
     let matchingLabel
     if (allowedLabels.length > 0) {
-      matchingLabel = match.findMatching(labelNames, allowedLabels, false, defaultMatch)
+      matchingLabel = match.findMatching(
+        labelNames,
+        allowedLabels,
+        false,
+        defaultMatch
+      )
     } else if (allowedMultipleLabels.length > 0) {
       matchingLabel = match.findMatching(
         labelNames,

match.js

@@ -7,14 +7,23 @@ function parseAllowed(allowed) {
   )
 }
 
-function findMatching(labelNames, allowedLabels, isMultipleAllowed, defaultValue) {
+function findMatching(
+  labelNames,
+  allowedLabels,
+  isMultipleAllowed,
+  defaultMatch
+) {
   const allowedLabelsSet = new Set(allowedLabels)
   const matchingLabels = labelNames.filter((labelName) =>
     allowedLabelsSet.has(labelName)
   )
-  if ( matchingLabels.length === 0 && defaultValue !== undefined) {
-    return [defaultValue]
+  if (
+    matchingLabels.length === 0 &&
+    (defaultMatch !== undefined || defaultMatch === '')
+  ) {
+    return [defaultMatch]
   }
+
   if (
     isMultipleAllowed
       ? matchingLabels.length === 0

match.test.js

@@ -68,4 +68,54 @@ test('match returns default for no labels', (t) => {
     'default'
   )
   t.deepEqual(matchedLabel, ['default'])
-})
+})
+
+test('match returns default for no matching labels', (t) => {
+  const matchedLabel = match.findMatching(
+    ['not matching'],
+    ['major', 'minor', 'patch'],
+    false,
+    'default'
+  )
+  t.deepEqual(matchedLabel, ['default'])
+})
+
+test('match returns default for no matching multiple labels', (t) => {
+  const matchedLabel = match.findMatching(
+    ['not matching', 'still not'],
+    ['major', 'minor', 'patch'],
+    true,
+    'default'
+  )
+  t.deepEqual(matchedLabel, ['default'])
+})
+
+test('match does not return default for matching labels', (t) => {
+  const matchedLabel = match.findMatching(
+    ['not matching', 'minor'],
+    ['major', 'minor', 'patch'],
+    false,
+    'default'
+  )
+  t.deepEqual(matchedLabel, ['minor'])
+})
+
+test('match does not return default for matchin multiple labels', (t) => {
+  const matchedLabel = match.findMatching(
+    ['major', 'minor'],
+    ['major', 'minor', 'patch'],
+    true,
+    'default'
+  )
+  t.deepEqual(matchedLabel, ['major', 'minor'])
+})
+
+test('match does not return default for matchin multiple labels but not all', (t) => {
+  const matchedLabel = match.findMatching(
+    ['patch', 'not matching', 'minor'],
+    ['major', 'minor', 'patch'],
+    true,
+    'default'
+  )
+  t.deepEqual(matchedLabel, ['patch', 'minor'])
+})