github-action-readme-generator 1.12.3 → 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 +7 -0
- package/README.md +1 -1
- package/dist/bin/index.js +6 -4
- package/dist/mjs/index.js +4 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
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
|
+
|
|
1
8
|
## [1.12.3](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.2...v1.12.3) (2026-08-15)
|
|
2
9
|
|
|
3
10
|
|
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.
|
|
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}`);
|
|
@@ -320995,7 +320995,7 @@ function generateImgMarkup(inputs, width = "15%") {
|
|
|
320995
320995
|
log.info(`Generating action.yml branding image for ${iconName}`);
|
|
320996
320996
|
const svg = inputs.config.get("image_generated");
|
|
320997
320997
|
const hash = `${iconName}${brandColor}`;
|
|
320998
|
-
if (svg
|
|
320998
|
+
if (!svg || hash.localeCompare(svg) !== 0 || !existsSync(svgPath)) {
|
|
320999
320999
|
generateSvgImage(svgPath, iconName, brandColor);
|
|
321000
321000
|
inputs.config.set("image_generated", hash);
|
|
321001
321001
|
}
|
|
@@ -321474,6 +321474,7 @@ var GHActionDocsConfig = class {
|
|
|
321474
321474
|
title;
|
|
321475
321475
|
paths;
|
|
321476
321476
|
branding_svg_path;
|
|
321477
|
+
image_generated;
|
|
321477
321478
|
versioning;
|
|
321478
321479
|
prettier;
|
|
321479
321480
|
/**
|
|
@@ -321488,6 +321489,7 @@ var GHActionDocsConfig = class {
|
|
|
321488
321489
|
this.title = config.title;
|
|
321489
321490
|
this.paths = config.paths;
|
|
321490
321491
|
this.branding_svg_path = config.branding_svg_path;
|
|
321492
|
+
this.image_generated = config.image_generated;
|
|
321491
321493
|
this.versioning = config.versioning;
|
|
321492
321494
|
this.prettier = config.prettier;
|
|
321493
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";
|
|
@@ -1609,7 +1609,7 @@ function generateImgMarkup(inputs, width = "15%") {
|
|
|
1609
1609
|
log.info(`Generating action.yml branding image for ${iconName}`);
|
|
1610
1610
|
const svg = inputs.config.get("image_generated");
|
|
1611
1611
|
const hash = `${iconName}${brandColor}`;
|
|
1612
|
-
if (svg
|
|
1612
|
+
if (!svg || hash.localeCompare(svg) !== 0 || !existsSync(svgPath)) {
|
|
1613
1613
|
generateSvgImage(svgPath, iconName, brandColor);
|
|
1614
1614
|
inputs.config.set("image_generated", hash);
|
|
1615
1615
|
}
|
|
@@ -2088,6 +2088,7 @@ var GHActionDocsConfig = class {
|
|
|
2088
2088
|
title;
|
|
2089
2089
|
paths;
|
|
2090
2090
|
branding_svg_path;
|
|
2091
|
+
image_generated;
|
|
2091
2092
|
versioning;
|
|
2092
2093
|
prettier;
|
|
2093
2094
|
/**
|
|
@@ -2102,6 +2103,7 @@ var GHActionDocsConfig = class {
|
|
|
2102
2103
|
this.title = config.title;
|
|
2103
2104
|
this.paths = config.paths;
|
|
2104
2105
|
this.branding_svg_path = config.branding_svg_path;
|
|
2106
|
+
this.image_generated = config.image_generated;
|
|
2105
2107
|
this.versioning = config.versioning;
|
|
2106
2108
|
this.prettier = config.prettier;
|
|
2107
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.
|
|
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",
|