github-action-readme-generator 1.12.7 → 1.12.9

package/dist/mjs/index.d.ts

@@ -2,6 +2,5 @@
 /**
  * Creates a ReadmeGenerator instance and generates docs.
  */
-declare function generateReadme(): Promise<void>;
-//#endregion
-export { generateReadme };
+export declare function generateReadme(): Promise<void>;
+//#endregion

package/dist/mjs/index.js

@@ -717,14 +717,15 @@ function getCurrentVersionString(inputs) {
 		const actionDir = path$1.dirname(inputs.action.path);
 		log.debug(`version source: ${versionSource}`);
 		let detectedVersion;
-		if (versionSource === "explicit") if (override && override.length > 0) {
-			detectedVersion = override;
-			log.debug(`using explicit version override: ${detectedVersion}`);
+		if (versionSource === "explicit") {
+			if (override && override.length > 0) {
+				detectedVersion = override;
+				log.debug(`using explicit version override: ${detectedVersion}`);
+			} else {
+				log.debug("explicit mode but no version_override set, falling back to 0.0.0");
+				detectedVersion = "0.0.0";
+			}
 		} else {
-			log.debug("explicit mode but no version_override set, falling back to 0.0.0");
-			detectedVersion = "0.0.0";
-		}
-		else {
 			switch (versionSource) {
 				case "git-branch":
 					detectedVersion = getVersionFromGitBranch(actionDir, log);
@@ -1489,10 +1490,12 @@ function loadConfig(log, providedConfig, configFilePath) {
 	const config = providedConfig ?? new Provider();
 	if (process.env.GITHUB_ACTION === "true") log.info("Running in GitHub action");
 	config.argv(argvOptions);
-	if (configFilePath) if (fs.existsSync(configFilePath)) {
-		log.info(`Config file found: ${configFilePath}`);
-		config.file(configFilePath);
-	} else log.debug(`Config file not found: ${configFilePath}`);
+	if (configFilePath) {
+		if (fs.existsSync(configFilePath)) {
+			log.info(`Config file found: ${configFilePath}`);
+			config.file(configFilePath);
+		} else log.debug(`Config file not found: ${configFilePath}`);
+	}
 	config.env({
 		lowerCase: true,
 		parseValues: true,
@@ -1953,13 +1956,18 @@ function headerToAnchor(text) {
 function extractHeaders(content) {
 	const headers = [];
 	const lines = content.split("\n");
-	let inCodeBlock = false;
+	let codeFence;
 	for (const line of lines) {
-		if (line.trim().startsWith("```")) {
-			inCodeBlock = !inCodeBlock;
+		const fenceMatch = /^\s*(`{3,}|~{3,})/.exec(line);
+		if (codeFence) {
+			const fenceCharacter = codeFence[0];
+			if (new RegExp(`^\\s*${fenceCharacter}{${codeFence.length},}\\s*$`).test(line)) codeFence = void 0;
+			continue;
+		}
+		if (fenceMatch) {
+			codeFence = fenceMatch[1];
 			continue;
 		}
-		if (inCodeBlock) continue;
 		const headerMatch = /^(#{2,6})\s+(.+)$/.exec(line);
 		if (headerMatch) {
 			const level = headerMatch[1].length;
@@ -2224,6 +2232,13 @@ function updateTitle(sectionToken, inputs) {
 }
 //#endregion
 //#region src/sections/update-usage.ts
+/**
+* Renders the `usage` section: a fenced workflow snippet naming every action input,
+* each preceded by its description and default as YAML comments.
+* @param {ReadmeSection} sectionToken - The README marker pair to write the section into.
+* @param {Inputs} inputs - The parsed action metadata and the README editor to write with.
+* @returns {Promise<Record<string, string>>} The rendered section, keyed by its section token.
+*/
 async function updateUsage(sectionToken, inputs) {
 	const log = new LogTask(sectionToken);
 	log.start();
@@ -2233,6 +2248,8 @@ async function updateUsage(sectionToken, inputs) {
 	log.info(`Version string: ${versionString}`);
 	const actionReference = `${actionName}@${versionString}`;
 	const indent = "    # ";
+	const defaultLabel = "Default: ";
+	const defaultHang = " ".repeat(9);
 	const content = [];
 	content.push("```yaml", `- uses: ${actionReference}`, "  with:");
 	const inp = inputs.action.inputs;
@@ -2259,7 +2276,11 @@ async function updateUsage(sectionToken, inputs) {
 			if (input !== void 0) {
 				if (!firstInput) content.push("");
 				content.push(...descriptions[key]);
-				if (input.default !== void 0) content.push(`${indent}Default: ${input.default}`);
+				if (input.default !== void 0) {
+					const [firstLine, ...rest] = `${input.default}`.split(/\r\n|\n|\r/);
+					content.push(`${indent}${defaultLabel}${firstLine}`.trimEnd());
+					for (const line of rest) content.push(`${indent}${defaultHang}${line}`.trimEnd());
+				}
 				content.push(`    ${key}: ''`);
 				firstInput = false;
 			}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-action-readme-generator",
   "displayName": "bitflight-devops/github-action-readme-generator",
-  "version": "1.12.7",
+  "version": "1.12.9",
   "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.",
   "keywords": [
     "github-actions",
@@ -149,11 +149,11 @@
     "@commitlint/prompt": "^21.0.1",
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/exec": "^7.1.0",
-    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/git": "^11.0.1",
     "@tsconfig/node24": "^24.0.4",
     "@types/nconf": "^0.10.5",
     "@types/node": "^26.1.1",
-    "@vitest/coverage-v8": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
     "@voidzero-dev/vite-plus-core": "0.2.8",
     "commitizen": "^4.3.1",
     "conventional-commits": "^1.6.0",
@@ -168,7 +168,7 @@
     "semantic-release": "^25.0.2",
     "types-package-json": "^2.0.39",
     "typescript": "7.0.2",
-    "vite-plus": "0.2.8"
+    "vite-plus": "0.3.1"
   },
   "engines": {
     "node": ">=24.19.0 <30.0.0",