chore: implement information parameters action

README.md

@@ -19,7 +19,7 @@
 
 # action-confluence-sync
 
-action-confluence-sync for project
+Action confluence sync that can be used to publish markdown documents to confluence. This action is a thin wrapper around the mark See the action.yaml file for details of required inputs.
 
 ## Requirements
 
@@ -70,6 +70,31 @@ jobs:
           files: '${{ steps.changed-files.outputs.all_changed_files }}'
 ```
 
+ <!-- action-docs-inputs -->
+
+## Inputs
+
+| parameter           | description            | required | default |
+| ------------------- | ---------------------- | -------- | ------- |
+| confluence_url      | base url of confluence | `true`   |         |
+| confluence_username | confluence username    | `true`   |         |
+| confluence_token    | token of user          | `true`   |         |
+| files               | files to sync          | `true`   |         |
+
+<!-- action-docs-inputs -->
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-runs -->
+
+## Runs
+
+This action is an `composite` action.
+
+<!-- action-docs-runs -->
+
 ## Help
 
 **Got a question?**

Taskfile.yml

@@ -85,11 +85,13 @@ tasks:
     desc: Generate Readme
     silent: true
     cmds:
+      - cmd: action-docs --update-readme docs/include/actions.md
       - >-
         gomplate --file {{.README_TEMPLATE}}
         --out {{.README_FILE}}
         --datasource config={{.README_YAML}}
         --datasource includes={{.README_INCLUDES}}
+      - task: prettier
 
   prettier:
     run: once

action.yml

@@ -1,5 +1,5 @@
 name: hadenlabs-action-confluence-sync'
-description: 'sync files markdown using mark'
+description: 'Action confluence sync that can be used to publish markdown documents to confluence.'
 author: 'hadenlabs'
 inputs:
   confluence_url:

docs/include/actions.md

@@ -0,0 +1,24 @@
+<!-- action-docs-inputs -->
+
+## Inputs
+
+| parameter           | description            | required | default |
+| ------------------- | ---------------------- | -------- | ------- |
+| confluence_url      | base url of confluence | `true`   |         |
+| confluence_username | confluence username    | `true`   |         |
+| confluence_token    | token of user          | `true`   |         |
+| files               | files to sync          | `true`   |         |
+
+<!-- action-docs-inputs -->
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-runs -->
+
+## Runs
+
+This action is an `composite` action.
+
+<!-- action-docs-runs -->

provision/generators/README.yaml

@@ -56,7 +56,11 @@ requirements: |-
 # Short description of this project
 description: |-
 
-  action-confluence-sync for project
+  Action confluence sync that can be used to publish markdown documents to confluence. This action is a thin wrapper around the mark
+  See the action.yaml file for details of required inputs.
+
+include:
+  - 'docs/include/actions.md'
 
 usages:
   - docs/usage.md