feat: only add description subject to table

Instead of adding the whole description to the table of inputs and outputs only the first line should be added.

Similar to best practice of git commit messages the description would benefit if the description will be split to subject and body.
In the first line the basic information will be placed (subject).
Followed after a blank line the body will follow.

For the action the body will then be available in the usage section only.
This will improve the readability of the table.

src/sections/update-inputs.ts

@@ -15,9 +15,21 @@ export default function updateInputs(token: string, inputs: Inputs): void {
     for (const key of Object.keys(vars)) {
       // eslint-disable-next-line security/detect-object-injection
       const values = vars[key];
+
+      let description = values?.description ?? '';
+
+      // Check if only first line should be added (only subject without body)
+      // eslint-disable-next-line no-useless-escape
+      const matches = description.match('(.*?)\n\n([\S\s]*)');
+      if (matches && matches.length >= 2) {
+        description = matches[1] || description;
+      }
+
+      description = description.trim().replace('\n', '<br />');
+
       const row: string[] = [
         `**\`${key.trim()}\`**`,
-        values?.description?.trim().replace('\n', '<br />') ?? '',
+        description,
         values?.default ? `\`${values.default}\`` : '',
         values?.required ? '**true**' : '__false__',
       ];

src/sections/update-outputs.ts

@@ -18,9 +18,21 @@ export default function updateOutputs(token: string, inputs: Inputs): void {
     for (const key of Object.keys(vars)) {
       // eslint-disable-next-line security/detect-object-injection
       const values = vars[key];
+
+      let description = values?.description ?? '';
+
+      // Check if only first line should be added (only subject without body)
+      // eslint-disable-next-line no-useless-escape
+      const matches = description.match('(.*?)\n\n([\S\s]*)');
+      if (matches && matches.length >= 2) {
+        description = matches[1] || description;
+      }
+
+      description = description.trim().replace('\n', '<br />');
+
       const row: string[] = [
         `\`${key.trim()}\``,
-        values?.description?.trim().replace('\n', '<br />') ?? '',
+        description,
       ];
       log.debug(JSON.stringify(row));
       markdownArray.push(row);