feat: add support for workflows and readme all option

README.md

@@ -33,7 +33,8 @@ The action will not commit any change, to ensure the changes are persisted you c
 | name | description | required | default |
 | --- | --- | --- | --- |
 | `readme` | <p>Readme file to update.</p> | `false` | `README.md` |
-| `actionFile` | <p>THe action definition file.</p> | `false` | `action.yml` |
+| `actionFile` | <p>The action definition file.</p> | `false` | `""` |
+| `sourceFile` | <p>The action or workflow definition file.</p> | `false` | `action.yml` |
 | `includeNameHeader` | <p>Include the name header in the updated readme.</p> | `false` | `true` |
 | `tocLevel` | <p>TOC level used for the headers. The <code>includeNameHeader</code> input is influecing the TOC level, setting <code>includeNameHeader</code> to true will increase the TOC level by 1.</p> | `false` | `2` |
 | `lineBreaks` | <p>Line breaks to be used in updated readme (LF|CR|CRLF).</p> | `false` | `LF` |

action.yml

@@ -12,7 +12,11 @@ inputs:
     required: false
     default: README.md
   actionFile:
-    description: 'THe action definition file.'
+    description: 'The action definition file.'
+    required: false
+    deprecationMessage: 'This input is replaced by sourceFile'
+  sourceFile:
+    description: 'The action or workflow definition file.'
     required: false
     default: action.yml
   includeNameHeader:

package.json

@@ -28,7 +28,7 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "action-docs": "^2.1.0"
+    "action-docs": "^2.2.0"
   },
   "devDependencies": {
     "@types/node": "^20.11.24",

src/main.ts

@@ -5,12 +5,13 @@ async function run(): Promise<void> {
   try {
     const readmeFile: string = core.getInput('readme', { required: true });
     const tocLevel: number = parseInt(core.getInput('tocLevel', { required: true }));
-    const actionFile: string = core.getInput('actionFile', { required: true });
+    const actionFile: string = core.getInput('actionFile');
+    const sourceFile: string = actionFile || core.getInput('sourceFile');
     const lineBreaks = core.getInput('lineBreaks', { required: true }) as 'LF' | 'CR' | 'CRLF';
     const includeNameHeader = core.getInput('includeNameHeader', { required: true }) === 'true';
 
     await generateActionMarkdownDocs({
-      actionFile,
+      sourceFile,
       readmeFile,
       updateReadme: true,
       tocLevel,