action-docs - npm Package Compare versions

Comparing version 2.3.0 to 2.4.0

CHANGELOG.md

 # Changelog
 
+## [2.4.0](https://github.com/npalm/action-docs/compare/v2.3.0...v2.4.0) (2024-03-13)
+
+
+### Features
+
+* Add support for inputs deprecationMessage ([#566](https://github.com/npalm/action-docs/issues/566)) ([e283563](https://github.com/npalm/action-docs/commit/e283563580e9f0cc0e71cd4205ef587e50845ef9))
+
 ## [2.3.0](https://github.com/npalm/action-docs/compare/v2.2.0...v2.3.0) (2024-03-09)
@@ -4,0 +11,0 @@

lib/action-docs.js

@@ -246,2 +246,12 @@ import { getLineBreak } from "./linebreak.js";
             }
+            else if (columnName === "description") {
+                rowValue = value[columnName];
+                if (value["deprecationMessage"] !== undefined) {
+                    rowValue += "<br/>_Deprecated";
+                    if (value["deprecationMessage"] !== "") {
+                        rowValue += `: ${value["deprecationMessage"]}`;
+                    }
+                    rowValue += "_";
+                }
+            }
             else if (columnName === "default") {
@@ -248,0 +258,0 @@ rowValue =

package.json

 {
   "name": "action-docs",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Generate GitHub action docs based on action.yml",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

src/action-docs.ts

@@ -96,2 +96,3 @@ import { LineBreakType, getLineBreak } from "./linebreak.js";
   type?: InputType;
+  deprecationMessage?: string;
 }
@@ -419,2 +420,11 @@
         rowValue = key;
+      } else if (columnName === "description") {
+        rowValue = value[columnName];
+        if (value["deprecationMessage"] !== undefined) {
+          rowValue += "<br/>_Deprecated";
+          if (value["deprecationMessage"] !== "") {
+            rowValue += `: ${value["deprecationMessage"]}`;
+          }
+          rowValue += "_";
+        }
       } else if (columnName === "default") {
@@ -421,0 +431,0 @@ rowValue =

No alert changes

Improved metrics

Total package byte prevSize

46950

increased by2.45%

Lines of code

919

increased by2.22%

No dependency changes