action-docs - npm Package Compare versions

Comparing version 0.1.0-beta.7 to 0.2.0-beta.1

lib/cli.js

@@ -53,5 +53,1 @@ #!/usr/bin/env node
 /* eslint-enable */
-// if (args["update-readme"]) {
-//   console.log("--------ddd-");
-// }
-// console.log(args);

lib/index.d.ts

@@ -1,1 +0,1 @@
-export { generateActionMarkdownDocs, Options, defaultOptions, } from "./terraform-docs";
+export { generateActionMarkdownDocs, Options, defaultOptions, } from "./action-docs";

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultOptions = exports.generateActionMarkdownDocs = void 0;
-var terraform_docs_1 = require("./terraform-docs");
-Object.defineProperty(exports, "generateActionMarkdownDocs", { enumerable: true, get: function () { return terraform_docs_1.generateActionMarkdownDocs; } });
-Object.defineProperty(exports, "defaultOptions", { enumerable: true, get: function () { return terraform_docs_1.defaultOptions; } });
+var action_docs_1 = require("./action-docs");
+Object.defineProperty(exports, "generateActionMarkdownDocs", { enumerable: true, get: function () { return action_docs_1.generateActionMarkdownDocs; } });
+Object.defineProperty(exports, "defaultOptions", { enumerable: true, get: function () { return action_docs_1.defaultOptions; } });

package.json

 {
   "name": "action-docs",
-  "version": "0.1.0-beta.7",
+  "version": "0.2.0-beta.1",
   "description": "Generate GitHub action docs based on action.yml",
@@ -64,3 +64,2 @@ "main": "lib/index.js",
     "jest-circus": "^26.6.3",
-    "marked": "^1.0.0",
     "prettier": "2.2.1",
@@ -79,2 +78,2 @@ "semantic-release": "^17.3.9",
   }
-}
+}

README.md

 # Action docs
 
-This cli let you generate, and update document for GitHub actions based on the action definition yml.
+A clie to generate, and update documentation for GitHub actions based on the action definition yml. To update your README in a GitHub workflow you can use the [action-docs-action](https://github.com/npalm/action-docs-action).
 
@@ -17,3 +17,3 @@ ## TL;DR
 # update reamde
-action-ducs --update-readme
+action-docs --update-readme
 ```
@@ -25,9 +25,9 @@
 ## Add the following comment blocks to your README.md
-<!-- terraform-docs-description -->
+<!-- action-docs-description -->
 
-<!-- terraform-docs-inputs -->
+<!-- action-docs-inputs -->
 
-<!-- terraform-docs-outputs -->
+<!-- action-docs-outputs -->
 
-<!-- terraform-docs-runs -->
+<!-- action-docs-runs -->
 
@@ -61,9 +61,9 @@ ## Run the cli
 ```
-<!-- terraform-docs-description -->
+<!-- action-docs-description -->
 
-<!-- terraform-docs-inputs -->
+<!-- action-docs-inputs -->
 
-<!-- terraform-docs-outputs -->
+<!-- action-docs-outputs -->
 
-<!-- terraform-docs-runs -->
+<!-- action-docs-runs -->
 ```
@@ -124,2 +124,2 @@
 
-This project are released under the [MIT License](./LICENSE).
+This project are released under the [MIT License](./LICENSE).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

23

decreased by-4.17%

Number of lines in readme file

122

increased by0.83%

Worsened metrics

Total package byte prevSize

13334

decreased by-0.31%

Lines of code

193

decreased by-2.03%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes