github-action-readme-generator 1.12.2 → 1.12.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ ## [1.12.4](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.3...v1.12.4) (2026-08-15)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * **branding:** generate SVG on first run ([#664](https://github.com/bitflight-devops/github-action-readme-generator/issues/664)) ([1e1910e](https://github.com/bitflight-devops/github-action-readme-generator/commit/1e1910ec9a3926487c5ae06efa89db99e79efc24))
7
+
8
+ ## [1.12.3](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.2...v1.12.3) (2026-08-15)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **cli:** parse sections as an array ([#665](https://github.com/bitflight-devops/github-action-readme-generator/issues/665)) ([9d6c0a2](https://github.com/bitflight-devops/github-action-readme-generator/commit/9d6c0a23a7f246f1e165df859e3c2c58d5772664))
14
+
1
15
  ## [1.12.2](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.1...v1.12.2) (2026-08-15)
2
16
 
3
17
 
package/README.md CHANGED
@@ -177,7 +177,7 @@ This configuration will automatically regenerate your README whenever `action.ym
177
177
  <!-- start usage -->
178
178
 
179
179
  ```yaml
180
- - uses: bitflight-devops/github-action-readme-generator@v1.12.1
180
+ - uses: bitflight-devops/github-action-readme-generator@v1.12.3
181
181
  with:
182
182
  # Description: The absolute or relative path to the `action.yml` file to read in
183
183
  # from.
package/dist/bin/index.js CHANGED
@@ -4,14 +4,14 @@ await(async()=>{let{dirname:e}=await import("path"),{fileURLToPath:i}=await impo
4
4
 
5
5
  import { createRequire } from "node:module";
6
6
  import * as fs$10 from "node:fs";
7
- import { accessSync, promises, readFileSync } from "node:fs";
7
+ import { accessSync, existsSync, promises, readFileSync } from "node:fs";
8
8
  import * as path$2 from "node:path";
9
9
  import path, { dirname, join } from "node:path";
10
10
  import * as os$10 from "os";
11
11
  import os, { EOL } from "os";
12
12
  import * as crypto$2 from "crypto";
13
13
  import * as fs$16 from "fs";
14
- import fs4, { constants, existsSync, promises as promises$1, readFileSync as readFileSync$1, realpathSync, statSync } from "fs";
14
+ import fs4, { constants, existsSync as existsSync$1, promises as promises$1, readFileSync as readFileSync$1, realpathSync, statSync } from "fs";
15
15
  import * as path$6 from "path";
16
16
  import path10, { dirname as dirname$1 } from "path";
17
17
  import * as events from "events";
@@ -17034,7 +17034,7 @@ var Context$1 = class {
17034
17034
  constructor() {
17035
17035
  var _a, _b, _c;
17036
17036
  this.payload = {};
17037
- if (process.env.GITHUB_EVENT_PATH) if (existsSync(process.env.GITHUB_EVENT_PATH)) this.payload = JSON.parse(readFileSync$1(process.env.GITHUB_EVENT_PATH, { encoding: "utf8" }));
17037
+ if (process.env.GITHUB_EVENT_PATH) if (existsSync$1(process.env.GITHUB_EVENT_PATH)) this.payload = JSON.parse(readFileSync$1(process.env.GITHUB_EVENT_PATH, { encoding: "utf8" }));
17038
17038
  else {
17039
17039
  const path = process.env.GITHUB_EVENT_PATH;
17040
17040
  process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${EOL}`);
@@ -171659,6 +171659,16 @@ argvOptions["debug:config"] = {
171659
171659
  type: "boolean"
171660
171660
  };
171661
171661
  /**
171662
+ * README sections option configuration.
171663
+ * Declaring this as an array keeps a single `--sections=usage` value consistent
171664
+ * with the array shape used by `.ghadocs.json` and repeated CLI arguments.
171665
+ */
171666
+ argvOptions.sections = {
171667
+ alias: "sections",
171668
+ describe: "Only generate the named README section (repeat for multiple sections)",
171669
+ type: "array"
171670
+ };
171671
+ /**
171662
171672
  * Configuration inputs from the github action don't
171663
171673
  * all match the input names when running on cli.
171664
171674
  * This maps the action inputs to the cli.
@@ -320985,7 +320995,7 @@ function generateImgMarkup(inputs, width = "15%") {
320985
320995
  log.info(`Generating action.yml branding image for ${iconName}`);
320986
320996
  const svg = inputs.config.get("image_generated");
320987
320997
  const hash = `${iconName}${brandColor}`;
320988
- if (svg && hash.localeCompare(svg) !== 0) {
320998
+ if (!svg || hash.localeCompare(svg) !== 0 || !existsSync(svgPath)) {
320989
320999
  generateSvgImage(svgPath, iconName, brandColor);
320990
321000
  inputs.config.set("image_generated", hash);
320991
321001
  }
@@ -321464,6 +321474,7 @@ var GHActionDocsConfig = class {
321464
321474
  title;
321465
321475
  paths;
321466
321476
  branding_svg_path;
321477
+ image_generated;
321467
321478
  versioning;
321468
321479
  prettier;
321469
321480
  /**
@@ -321478,6 +321489,7 @@ var GHActionDocsConfig = class {
321478
321489
  this.title = config.title;
321479
321490
  this.paths = config.paths;
321480
321491
  this.branding_svg_path = config.branding_svg_path;
321492
+ this.image_generated = config.image_generated;
321481
321493
  this.versioning = config.versioning;
321482
321494
  this.prettier = config.prettier;
321483
321495
  }
package/dist/mjs/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as fs from "node:fs";
2
- import { accessSync, promises, readFileSync } from "node:fs";
2
+ import { accessSync, existsSync, promises, readFileSync } from "node:fs";
3
3
  import * as path$1 from "node:path";
4
4
  import path from "node:path";
5
5
  import * as core from "@actions/core";
@@ -1111,6 +1111,16 @@ argvOptions["debug:config"] = {
1111
1111
  type: "boolean"
1112
1112
  };
1113
1113
  /**
1114
+ * README sections option configuration.
1115
+ * Declaring this as an array keeps a single `--sections=usage` value consistent
1116
+ * with the array shape used by `.ghadocs.json` and repeated CLI arguments.
1117
+ */
1118
+ argvOptions.sections = {
1119
+ alias: "sections",
1120
+ describe: "Only generate the named README section (repeat for multiple sections)",
1121
+ type: "array"
1122
+ };
1123
+ /**
1114
1124
  * Configuration inputs from the github action don't
1115
1125
  * all match the input names when running on cli.
1116
1126
  * This maps the action inputs to the cli.
@@ -1599,7 +1609,7 @@ function generateImgMarkup(inputs, width = "15%") {
1599
1609
  log.info(`Generating action.yml branding image for ${iconName}`);
1600
1610
  const svg = inputs.config.get("image_generated");
1601
1611
  const hash = `${iconName}${brandColor}`;
1602
- if (svg && hash.localeCompare(svg) !== 0) {
1612
+ if (!svg || hash.localeCompare(svg) !== 0 || !existsSync(svgPath)) {
1603
1613
  generateSvgImage(svgPath, iconName, brandColor);
1604
1614
  inputs.config.set("image_generated", hash);
1605
1615
  }
@@ -2078,6 +2088,7 @@ var GHActionDocsConfig = class {
2078
2088
  title;
2079
2089
  paths;
2080
2090
  branding_svg_path;
2091
+ image_generated;
2081
2092
  versioning;
2082
2093
  prettier;
2083
2094
  /**
@@ -2092,6 +2103,7 @@ var GHActionDocsConfig = class {
2092
2103
  this.title = config.title;
2093
2104
  this.paths = config.paths;
2094
2105
  this.branding_svg_path = config.branding_svg_path;
2106
+ this.image_generated = config.image_generated;
2095
2107
  this.versioning = config.versioning;
2096
2108
  this.prettier = config.prettier;
2097
2109
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "github-action-readme-generator",
3
3
  "displayName": "bitflight-devops/github-action-readme-generator",
4
- "version": "1.12.2",
4
+ "version": "1.12.4",
5
5
  "description": "The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.",
6
6
  "keywords": [
7
7
  "github-actions",