fix: fixed example in documentation

nick-fields · Sep 29, 2020 · a5e5458 · a5e5458
1 parent e8ab059
commit a5e5458
Show file tree

Hide file tree

Showing 2 changed files with 135 additions and 6 deletions.
diff --git a/.actiongenrc.js b/.actiongenrc.js
@@ -42,14 +42,81 @@ module.exports = buildConfig({
   },
   usage: {
     examples: [
+      {
+        title: 'Example usage w/ exact (using default comparison) assertion',
+        codeLanguage: 'yaml',
+        codeBlock: `
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: testing
+    actual: \${{ steps.test-data.outputs.value }}
+`.trim(),
+      },
       {
         title: 'Example usage w/ exact assertion',
         codeLanguage: 'yaml',
         codeBlock: `
-- uses: nick-invision@assert-actionv1
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: testing
+    actual: \${{ steps.test-data.outputs.value }}
+    comparison: exact
+`.trim(),
+      },
+      {
+        title: 'Example usage w/ startsWith assertion',
+        codeLanguage: 'yaml',
+        codeBlock: `
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: test
+    actual: \${{ steps.test-data.outputs.value }}
+    comparison: startsWith
+`.trim(),
+      },
+      {
+        title: 'Example usage w/ endsWith assertion',
+        codeLanguage: 'yaml',
+        codeBlock: `
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: ing
+    actual: \${{ steps.test-data.outputs.value }}
+    comparison: endsWith
+`.trim(),
+      },
+      {
+        title: 'Example usage w/ contains assertion',
+        codeLanguage: 'yaml',
+        codeBlock: `
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: est
+    actual: \${{ steps.test-data.outputs.value }}
+    comparison: endsWith
+`.trim(),
+      },
+      {
+        title: 'Example usage w/ notEqual assertion',
+        codeLanguage: 'yaml',
+        codeBlock: `
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
   with:
-    expected: \${{ secrets.REPO_TOKEN }}
-    actual: \${{ steps.outputs }}
+    expected: abc
+    actual: \${{ steps.test-data.outputs.value }}
+    comparison: notEqual
 `.trim(),
       },
     ],

diff --git a/README.md b/README.md
@@ -30,13 +30,75 @@ Various assertions to aide in validating action outputs
 
 ## **Examples**
 
+### Example usage w/ exact (using default comparison) assertion
+
+```yaml
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: testing
+    actual: ${{ steps.test-data.outputs.value }}
+```
+
 ### Example usage w/ exact assertion
 
 ```yaml
-- uses: nick-invision@assert-actionv1
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: testing
+    actual: ${{ steps.test-data.outputs.value }}
+    comparison: exact
+```
+
+### Example usage w/ startsWith assertion
+
+```yaml
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: test
+    actual: ${{ steps.test-data.outputs.value }}
+    comparison: startsWith
+```
+
+### Example usage w/ endsWith assertion
+
+```yaml
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: ing
+    actual: ${{ steps.test-data.outputs.value }}
+    comparison: endsWith
+```
+
+### Example usage w/ contains assertion
+
+```yaml
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
+  with:
+    expected: est
+    actual: ${{ steps.test-data.outputs.value }}
+    comparison: endsWith
+```
+
+### Example usage w/ notEqual assertion
+
+```yaml
+- id: test-data
+  run: echo "::set-output name=value::testing"
+- uses: nick-invision@assert-action@v1
   with:
-    expected: ${{ secrets.REPO_TOKEN }}
-    actual: ${{ steps.outputs }}
+    expected: abc
+    actual: ${{ steps.test-data.outputs.value }}
+    comparison: notEqual
 ```
 
 ---