fix: more documentation

nick-fields · Sep 29, 2020 · 244bad2 · 244bad2
1 parent 788ad45
commit 244bad2
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/.actiongenrc.js b/.actiongenrc.js
@@ -22,7 +22,8 @@ module.exports = buildConfig({
     {
       id: 'comparison',
       description: {
-        short: 'Result of the comparison.  Can be either `passed` or `failed`',
+        short:
+          'Type of comparison to perform.  Supports "exact" (default), "startsWith", "endsWith", "contains", "notEqual"',
       },
       required: false,
       default: 'exact',
@@ -31,8 +32,7 @@ module.exports = buildConfig({
   outputs: [
     {
       id: 'result',
-      description:
-        'Result of the assertion.  Returns either "passed" or "failed',
+      description: 'Result of the comparison.  Can be either passed or failed',
     },
   ],
   runs: {

diff --git a/README.md b/README.md
@@ -16,15 +16,15 @@ Various assertions to aide in validating action outputs
 
 ### **`comparison`**
 
-**Optional** Result of the comparison.  Can be either `passed` or `failed`
+**Optional** Type of comparison to perform. Supports "exact" (default), "startsWith", "endsWith", "contains", "notEqual"
 
 ---
 
 ## **Outputs**
 
 ### **`result`**
 
-Various assertions to aide in validating action outputs
+Result of the comparison. Can be either passed or failed
 
 ---
 

diff --git a/action.yml b/action.yml
@@ -8,12 +8,12 @@ inputs:
     description: Actual value
     required: true
   comparison:
-    description: Result of the comparison.  Can be either `passed` or `failed`
+    description: Type of comparison to perform.  Supports "exact" (default), "startsWith", "endsWith", "contains", "notEqual"
     required: false
     default: exact
 outputs:
   result:
-    description: Various assertions to aide in validating action outputs
+    description: Result of the comparison.  Can be either passed or failed
 runs:
   using: node12
   main: dist/index.js