Merge remote-tracking branch 'origin' into GH-240-support-workflows

__tests__/action-docs-action.test.ts

@@ -25,6 +25,17 @@ describe("Test output", () => {
     expect(markdown).toEqual(expected);
   });
 
+  test("With name header included.", async () => {
+    const markdown = await generateActionMarkdownDocs({
+      includeNameHeader: true,
+    });
+    const expected = <string>(
+      readFileSync(path.join(fixtureDir, "default-with-header.output"), "utf-8")
+    );
+
+    expect(markdown).toEqual(expected);
+  });
+
   test("A minimal action definition.", async () => {
     const markdown = await generateActionMarkdownDocs({
       actionFile: path.join(fixtureDir, "minimal_action.yml"),
@@ -65,6 +76,19 @@ describe("Test update readme ", () => {
     });
   });
 
+  test("Filled readme (all fields) with header", async () => {
+    await testReadme(
+      {
+        actionFile: path.join(fixtureDir, "all_fields_action.yml"),
+        originalReadme: path.join(fixtureDir, "all_fields_readme.input"),
+        fixtureReadme: path.join(fixtureDir, "all_fields_readme_header.output"),
+      },
+      {},
+      false,
+      true,
+    );
+  });
+
   test("Readme (all fields) with CRLF line breaks", async () => {
     await testReadme(
       {
@@ -131,13 +155,15 @@ async function testReadme(
   files: ReadmeTestFixtures,
   overwriteOptions?: Options,
   doExpect: boolean = true,
+  includeNameHeader: boolean = false,
 ) {
   const expected = <string>readFileSync(files.fixtureReadme, "utf-8");
   const original = <string>readFileSync(files.originalReadme, "utf-8");
 
   await generateActionMarkdownDocs({
     actionFile: files.actionFile,
     updateReadme: true,
+    includeNameHeader: includeNameHeader,
     readmeFile: files.originalReadme,
     ...overwriteOptions,
   });

__tests__/fixtures/action/all_fields_readme.input

@@ -1,9 +1,70 @@
 <!-- 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" -->

__tests__/fixtures/action/all_fields_readme_header.output

@@ -0,0 +1,74 @@
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+# Test Action
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+
+<!-- action-docs-description action="__tests__/fixtures/all_fields_action.yml" -->
+## Description
+
+Default test
+<!-- action-docs-description action="__tests__/fixtures/all_fields_action.yml" -->
+
+<!-- action-docs-usage action="__tests__/fixtures/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/all_fields_action.yml" project="npalm/action-docs" version="v1" -->
+
+<!-- action-docs-inputs action="__tests__/fixtures/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/all_fields_action.yml" -->
+
+<!-- action-docs-outputs action="__tests__/fixtures/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/all_fields_action.yml" -->
+
+<!-- action-docs-runs action="__tests__/fixtures/all_fields_action.yml" -->
+## Runs
+
+This action is a `node12` action.
+<!-- action-docs-runs action="__tests__/fixtures/all_fields_action.yml" -->

__tests__/fixtures/action/default-with-header.output

@@ -47,4 +47,3 @@ This action is a `node12` action.
     # Default: test
 ```
 
-

__tests__/fixtures/workflow/all_fields_readme.input

@@ -1,9 +1,74 @@
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+## An Action
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+
+<!-- action-docs-description action="__tests__/fixtures/all_fields_action.yml" -->
+### Description
+
+Default test
 <!-- action-docs-description action="__tests__/fixtures/all_fields_action.yml" -->
 
 <!-- action-docs-usage action="__tests__/fixtures/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/all_fields_action.yml" project="npalm/action-docs" version="v1" -->
+
+<!-- action-docs-inputs action="__tests__/fixtures/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/all_fields_action.yml" -->
 
 <!-- action-docs-outputs action="__tests__/fixtures/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/all_fields_action.yml" -->
+
+<!-- action-docs-runs action="__tests__/fixtures/all_fields_action.yml" -->
+### Runs
 
+This action is a `node12` action.
 <!-- action-docs-runs action="__tests__/fixtures/all_fields_action.yml" -->

__tests__/fixtures/workflow/all_fields_readme.output

@@ -1,3 +1,7 @@
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+
+<!-- action-docs-header action="__tests__/fixtures/all_fields_action.yml" -->
+
 <!-- action-docs-description action="__tests__/fixtures/all_fields_action.yml" -->
 ## Description