Merge pull request #3 from tjtharrison/testing_inputs

Set type for inputs
tjtharrison · Feb 7, 2023 · c51e6b5 · c51e6b5
2 parents ce77ff1 + 26ecaa3
commit c51e6b5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,17 @@ Github Action to generate github-actions docs for a composite action.
 
 <!-- BEGIN_ACTION_DOCS -->
 
+# github-actions-docs
+
+Generate GitHub action docs for action
+
+# inputs
+
+| Title | Required | Type | Description |
+|-----|-----|-----|-----|
+| ACTION_FILE_NAME | True | string |The name of the file to be processed |
+| OUTPUT_FILE_NAME | True | string |The file that the output report will be written to |
+| OUTPUT_MODE | True | string |The output mode, [update/overwrite]. Update will be inserted after a line containing <!-- INSERT_ACTION_DOCS -->, overwrite will overwrite the whole file |
 <!-- END_ACTION_DOCS -->
 
 # Local development

diff --git a/action.yaml b/action.yaml
@@ -4,14 +4,17 @@ inputs:
   ACTION_FILE_NAME:
     description: "The name of the file to be processed"
     required: true
+    type: string
     default: "action.yaml"
   OUTPUT_FILE_NAME:
     description: "The file that the output report will be written to"
     required: true
+    type: string
     default: "README.md"
   OUTPUT_MODE:
     description: "The output mode, [update/overwrite]. Update will be inserted after a line containing <!-- INSERT_ACTION_DOCS -->, overwrite will overwrite the whole file"
     required: true
+    type: string
     default: "update"
 runs:
   using: "composite"