npalmGH-240 add backwards compatibility test

larmitage-bjss · Mar 5, 2024 · dfa6c51 · dfa6c51
1 parent bd71f41
commit dfa6c51
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 0 deletions.
diff --git a/__tests__/action-docs-action.test.ts b/__tests__/action-docs-action.test.ts
@@ -166,6 +166,21 @@ describe("Test usage format", () => {
   });
 });
 
+describe("Backwards compatibility", () => {
+  test("Deprecated action option still works correctly", async () => {
+    await testReadme(
+      {
+        actionFile: path.join(fixtureDir, "all_fields_action.yml"),
+        originalReadme: path.join(fixtureDir, "action_deprecated.input"),
+        fixtureReadme: path.join(fixtureDir, "action_deprecated.output"),
+      },
+      {
+        includeNameHeader: true,
+      },
+    );
+  });
+});
+
 interface ReadmeTestFixtures {
   actionFile: string;
   originalReadme: string;

diff --git a/__tests__/fixtures/action/action_deprecated.input b/__tests__/fixtures/action/action_deprecated.input
@@ -0,0 +1,11 @@
+<!-- action-docs-header action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-description action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-usage action="__tests__/fixtures/action/all_fields_action.yml" project="npalm/action-docs" version="v1" -->
+
+<!-- action-docs-inputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-outputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-runs action="__tests__/fixtures/action/all_fields_action.yml" -->
diff --git a/__tests__/fixtures/action/action_deprecated.output b/__tests__/fixtures/action/action_deprecated.output
@@ -0,0 +1,74 @@
+<!-- action-docs-header action="__tests__/fixtures/action/all_fields_action.yml" -->
+## An Action
+<!-- action-docs-header action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-description action="__tests__/fixtures/action/all_fields_action.yml" -->
+### Description
+
+Default test
+<!-- action-docs-description action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-usage action="__tests__/fixtures/action/all_fields_action.yml" project="npalm/action-docs" version="v1" -->
+### Usage
+
+```yaml
+- uses: npalm/action-docs@v1
+  with:
+    inputA:
+    # A description A
+    #
+    # Required: false
+    # Default: ""
+
+    inputB:
+    # A description B
+    #
+    # Required: true
+    # Default: ""
+
+    inputC:
+    # A description C
+    #
+    # Required: true
+    # Default: C
+
+    inputD:
+    # A description D
+    #
+    # Required: false
+    # Default: D
+
+    inputE:
+    # A description E
+    #
+    # Required: false
+    # Default: false
+```
+<!-- action-docs-usage action="__tests__/fixtures/action/all_fields_action.yml" project="npalm/action-docs" version="v1" -->
+
+<!-- action-docs-inputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+### Inputs
+
+| name | description | required | default |
+| --- | --- | --- | --- |
+| `inputA` | <p>A description A</p> | `false` | `""` |
+| `inputB` | <p>A description B</p> | `true` | `""` |
+| `inputC` | <p>A description C</p> | `true` | `C` |
+| `inputD` | <p>A description D</p> | `false` | `D` |
+| `inputE` | <p>A description E</p> | `false` | `false` |
+<!-- action-docs-inputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-outputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+### Outputs
+
+| name | description |
+| --- | --- |
+| `outputA` | <p>A description A</p> |
+| `outputB` | <p>A description B</p> |
+<!-- action-docs-outputs action="__tests__/fixtures/action/all_fields_action.yml" -->
+
+<!-- action-docs-runs action="__tests__/fixtures/action/all_fields_action.yml" -->
+### Runs
+
+This action is a `node12` action.
+<!-- action-docs-runs action="__tests__/fixtures/action/all_fields_action.yml" -->