hdoc-tools 0.55.2 → 0.56.0

package/hdoc.js

@@ -128,7 +128,19 @@
 	let source_path = process.cwd();
 	let ui_path = path.join(__dirname, "ui");
 	let editor_path = path.join(__dirname, "editor", "dist");
-	let git_token = "";
+	// Default the GitHub token from the environment so nobody has to hand-pass a
+	// secret on the command line (and it never lands in shell history). GITHUB_TOKEN
+	// is the GitHub Actions / CI standard; GH_TOKEN is the gh-CLI convention. An
+	// explicit --git-token flag (parsed below) overrides either.
+	let git_token = process.env.GITHUB_TOKEN || process.env.GH_TOKEN || "";
+	// Track where the token came from purely so we can log it (masked) later — helps
+	// contributors confirm auth is active rather than silently falling back to the
+	// unauthenticated 60/hr limit because of a typo'd env var or wrong scope.
+	let git_token_source = process.env.GITHUB_TOKEN
+		? "GITHUB_TOKEN env"
+		: process.env.GH_TOKEN
+			? "GH_TOKEN env"
+			: "";
 	let command = ""; // Our command to run
 	let build_version = "";
 	let verbose = false;
@@ -170,6 +182,7 @@
 			x++;
 			if (x < process.argv.length) {
 				git_token = process.argv[x];
+				git_token_source = "--git-token flag";
 			}
 		} else if (process.argv[x].toLowerCase() === "--set-version") {
 			x++;
@@ -197,6 +210,24 @@
 	console.log("    Server Path:", __dirname);
 	console.log("  Document Path:", source_path, "\r\n");
 
+	// Confirm GitHub auth status for commands that pull contributor data, so a
+	// contributor can see at a glance whether the rate-limit-lifting token is
+	// actually in effect. Show only a short masked preview — never the full token.
+	if (command.toLowerCase() === "build" || command.toLowerCase() === "validate") {
+		if (git_token) {
+			const masked =
+				git_token.length > 8
+					? `${git_token.slice(0, 4)}…${git_token.slice(-2)}`
+					: "…";
+			console.log(`   GitHub Token: using ${git_token_source} [${masked}]`, "\r\n");
+		} else {
+			console.log(
+				"   GitHub Token: none — using unauthenticated GitHub API (60 requests/hour). Set GITHUB_TOKEN to raise the limit.",
+				"\r\n",
+			);
+		}
+	}
+
 
 	// Add validated-links.txt to .gitignore if it doesn't exist
 	const gitignorePath = path.join(source_path, ".gitignore");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hdoc-tools",
-	"version": "0.55.2",
+	"version": "0.56.0",
 	"description": "Hornbill HDocBook Development Support Tool",
 	"main": "hdoc.js",
 	"bin": {