actions-up 1.11.0 → 1.12.1

package/dist/core/api/check-updates.js

@@ -1,149 +1,161 @@
+import { normalizeVersion } from "../versions/normalize-version.js";
+import { isSemverLike } from "../versions/is-semver-like.js";
 import { createGitHubClient } from "./create-github-client.js";
 import semver from "semver";
-async function checkUpdates(n, i, c) {
-	let l = createGitHubClient(i), u = c?.includeBranches ?? !1, d = n.filter((e) => e.type === "external" || e.type === "reusable-workflow");
-	if (d.length === 0) return [];
-	let f = /* @__PURE__ */ new Map();
-	for (let e of d) {
-		let t = f.get(e.name) ?? [];
-		t.push(e), f.set(e.name, t);
+async function checkUpdates(i, o, l) {
+	let u = l?.client ?? createGitHubClient(o), d = l?.includeBranches ?? !1, f = i.filter((e) => e.type === "external" || e.type === "reusable-workflow");
+	if (f.length === 0) return [];
+	let p = /* @__PURE__ */ new Map();
+	for (let e of f) {
+		let t = p.get(e.name) ?? [];
+		t.push(e), p.set(e.name, t);
 	}
-	let p = {
+	let m = {
 		rateLimitError: null,
 		rateLimitHit: !1
-	}, m = await [...f.keys()].reduce((e, n) => e.then(async (e) => {
-		if (p.rateLimitHit) return [...e, {
+	}, h = await [...p.keys()].reduce((n, i) => n.then(async (n) => {
+		if (m.rateLimitHit) return [...n, {
 			publishedAt: null,
 			version: null,
-			actionName: n,
+			actionName: i,
 			sha: null
 		}];
-		let r = n.split("/");
-		if (r.length < 2) return [...e, {
+		let a = i.split("/");
+		if (a.length < 2) return [...n, {
 			publishedAt: null,
 			version: null,
-			actionName: n,
+			actionName: i,
 			sha: null
 		}];
-		let [i, c] = r;
-		if (!i || !c) return [...e, {
+		let [o, l] = a;
+		if (!o || !l) return [...n, {
 			publishedAt: null,
 			version: null,
-			actionName: n,
+			actionName: i,
 			sha: null
 		}];
 		try {
-			let r = f.get(n)[0]?.version;
-			if (r && !isSha(r) && !isSemverLike(r) && await l.getRefType(i, c, r) === "branch" && !u) return [...e, {
+			let a = p.get(i)[0]?.version;
+			if (a && !isSha(a) && !isSemverLike(a) && await u.getRefType(o, l, a) === "branch" && !d) return [...n, {
 				skipReason: "branch",
 				status: "skipped",
 				publishedAt: null,
 				version: null,
-				actionName: n,
+				actionName: i,
 				sha: null
 			}];
-			let d = await l.getLatestRelease(i, c);
-			if (!d) {
-				let e = await l.getAllReleases(i, c, 1);
-				d = e.find((e) => !e.isPrerelease) ?? e[0] ?? null;
+			let f = await u.getLatestRelease(o, l);
+			if (!f) {
+				let e = await u.getAllReleases(o, l, 1);
+				f = e.find((e) => !e.isPrerelease) ?? e[0] ?? null;
 			}
-			if (d) {
-				let { publishedAt: r, version: o, sha: u } = d, f = !1;
+			if (f) {
+				let { publishedAt: a, version: s, sha: d } = f, p = !1;
 				{
-					let e = normalizeVersion(o), n = !!(o && o.trim() !== ""), r = n && /^v?\d+$/u.test(o.trim()), i = semver.valid(e);
-					f = !n || r || !i || !isSemverLike(o);
+					let n = normalizeVersion(s), i = !!(s && s.trim() !== ""), a = i && /^v?\d+$/u.test(s.trim()), o = semver.valid(n);
+					p = !i || a || !o || !isSemverLike(s);
 				}
-				if (f) {
-					let r = await l.getAllTags(i, c, 30);
-					if (r.length > 0) {
-						let u = r.filter((e) => isSemverLike(e.tag)).map((e) => ({
-							v: semver.valid(normalizeVersion(e.tag)),
-							raw: e
+				if (p) {
+					let a = await u.getAllTags(o, l, 30);
+					if (a.length > 0) {
+						let d = a.filter((e) => isSemverLike(e.tag)).map((t) => ({
+							v: semver.valid(normalizeVersion(t.tag)),
+							raw: t
 						}));
-						if (u.length > 0) {
-							u.sort((e, n) => {
-								let r = semver.rcompare(e.v, n.v);
-								if (r !== 0) return r;
+						if (d.length > 0) {
+							d.sort((e, t) => {
+								let n = semver.rcompare(e.v, t.v);
+								if (n !== 0) return n;
 								let i = /\d+\.\d+/u.test(e.raw.tag) ? 1 : 0;
-								return (/\d+\.\d+/u.test(n.raw.tag) ? 1 : 0) - i;
+								return (/\d+\.\d+/u.test(t.raw.tag) ? 1 : 0) - i;
 							});
-							let r = u[0].raw, s = semver.valid(normalizeVersion(o) ?? void 0);
-							if (!s || semver.gt(u[0].v, s) || semver.eq(u[0].v, s) && /\d+\.\d+/u.test(r.tag)) {
-								let t = r.tag, a = r.sha?.length ? r.sha : null;
-								if (!a && t) try {
-									a = await l.getTagSha(i, c, t);
-								} catch {}
-								return [...e, {
-									version: t,
+							let t = d[0].raw, a = semver.valid(normalizeVersion(s) ?? void 0);
+							if (!a || semver.gt(d[0].v, a) || semver.eq(d[0].v, a) && /\d+\.\d+/u.test(t.tag)) {
+								let e = t.tag, r = t.sha?.length ? t.sha : null;
+								if (!r && e) try {
+									r = await u.getTagSha(o, l, e);
+								} catch (e) {
+									if (isRateLimitError(e)) throw e;
+								}
+								return [...n, {
+									version: e,
 									publishedAt: null,
-									sha: a,
-									actionName: n
+									sha: r,
+									actionName: i
 								}];
 							}
 						}
 					}
 				}
-				if (!u && o) try {
-					u = await l.getTagSha(i, c, o);
-				} catch {}
-				return [...e, {
+				if (s) {
+					let e = d;
+					try {
+						d = await u.getTagSha(o, l, s) ?? e;
+					} catch (t) {
+						if (isRateLimitError(t)) throw t;
+						d = e;
+					}
+				}
+				return [...n, {
 					status: "ok",
-					publishedAt: r,
-					actionName: n,
-					version: o,
-					sha: u
+					publishedAt: a,
+					actionName: i,
+					version: s,
+					sha: d
 				}];
 			}
-			let p = await l.getAllTags(i, c, 30);
-			if (p.length > 0) {
-				let r = p.filter((e) => isSemverLike(e.tag)).map((e) => ({
-					v: semver.valid(normalizeVersion(e.tag)),
-					raw: e
-				})), o;
-				r.length > 0 ? (r.sort((e, n) => {
-					let r = semver.rcompare(e.v, n.v);
-					if (r !== 0) return r;
+			let m = await u.getAllTags(o, l, 30);
+			if (m.length > 0) {
+				let a = m.filter((e) => isSemverLike(e.tag)).map((t) => ({
+					v: semver.valid(normalizeVersion(t.tag)),
+					raw: t
+				})), s;
+				a.length > 0 ? (a.sort((e, t) => {
+					let n = semver.rcompare(e.v, t.v);
+					if (n !== 0) return n;
 					let i = /\d+\.\d+/u.test(e.raw.tag) ? 1 : 0;
-					return (/\d+\.\d+/u.test(n.raw.tag) ? 1 : 0) - i;
-				}), o = r[0].raw) : o = p[0];
-				let u = o.tag, d = o.sha?.length ? o.sha : null;
-				if (!d && u) try {
-					d = await l.getTagSha(i, c, u);
-				} catch {}
-				return [...e, {
+					return (/\d+\.\d+/u.test(t.raw.tag) ? 1 : 0) - i;
+				}), s = a[0].raw) : s = m[0];
+				let d = s.tag, f = s.sha?.length ? s.sha : null;
+				if (!f && d) try {
+					f = await u.getTagSha(o, l, d);
+				} catch (e) {
+					if (isRateLimitError(e)) throw e;
+				}
+				return [...n, {
 					status: "ok",
 					publishedAt: null,
-					actionName: n,
-					version: u,
-					sha: d
+					actionName: i,
+					version: d,
+					sha: f
 				}];
 			}
-			return [...e, {
+			return [...n, {
 				publishedAt: null,
 				version: null,
-				actionName: n,
+				actionName: i,
 				sha: null
 			}];
-		} catch (t) {
-			return t instanceof Error && t.name === "GitHubRateLimitError" ? (p.rateLimitHit = !0, p.rateLimitError = t, [...e, {
+		} catch (e) {
+			return e instanceof Error && e.name === "GitHubRateLimitError" ? (m.rateLimitHit = !0, m.rateLimitError = e, [...n, {
 				publishedAt: null,
 				version: null,
-				actionName: n,
+				actionName: i,
 				sha: null
-			}]) : (console.warn(`Failed to check ${n}:`, t), [...e, {
+			}]) : (console.warn(`Failed to check ${i}:`, e), [...n, {
 				publishedAt: null,
 				version: null,
-				actionName: n,
+				actionName: i,
 				sha: null
 			}]);
 		}
 	}), Promise.resolve([]));
-	if (p.rateLimitError) {
-		let e = !!(i ?? process.env.GITHUB_TOKEN), t = `${p.rateLimitError.message || "GitHub API rate limit exceeded."}\n${e ? "Wait for reset or reduce request rate." : "Please set GITHUB_TOKEN environment variable to increase the limit.\nSee: https://github.com/azat-io/actions-up?tab=readme-ov-file#using-github-token-for-higher-rate-limits"}`, n = Error(t);
+	if (m.rateLimitError) {
+		let e = !!(o ?? process.env.GITHUB_TOKEN), t = `${m.rateLimitError.message || "GitHub API rate limit exceeded."}\n${e ? "Wait for reset or reduce request rate." : "Please set GITHUB_TOKEN environment variable to increase the limit.\nSee: https://github.com/azat-io/actions-up?tab=readme-ov-file#github-token"}`, n = Error(t);
 		throw n.name = "GitHubRateLimitError", n;
 	}
-	let h = /* @__PURE__ */ new Map();
-	for (let e of m) h.set(e.actionName, {
+	let g = /* @__PURE__ */ new Map();
+	for (let e of h) g.set(e.actionName, {
 		publishedAt: e.publishedAt,
 		actionName: e.actionName,
 		skipReason: e.skipReason,
@@ -151,57 +163,57 @@ async function checkUpdates(n, i, c) {
 		status: e.status,
 		sha: e.sha
 	});
-	let g = [];
-	for (let e of d) {
-		let t = h.get(e.name);
-		t ? g.push(createUpdate(e, {
+	let _ = [];
+	for (let e of f) {
+		let t = g.get(e.name);
+		t ? _.push(createUpdate(e, {
 			publishedAt: t.publishedAt,
 			version: t.version,
 			sha: t.sha
 		}, {
 			skipReason: t.skipReason,
 			status: t.status
-		})) : g.push(createUpdate(e, {
+		})) : _.push(createUpdate(e, {
 			publishedAt: null,
 			version: null,
 			sha: null
 		}));
 	}
-	return g;
+	return _;
 }
-function createUpdate(e, n, r = {}) {
-	let { version: s, sha: c, publishedAt: l } = n, u = e.version ?? "unknown", d = normalizeVersion(u), f = s ? normalizeVersion(s) : null, p = r.status ?? "ok", m = r.skipReason, h = !1, g = !1;
+function createUpdate(t, n, i = {}) {
+	let { version: a, sha: c, publishedAt: l } = n, u = t.version ?? "unknown", d = normalizeVersion(u), f = a ? normalizeVersion(a) : null, p = i.status ?? "ok", m = i.skipReason, h = !1, g = !1;
 	if (p === "skipped") return {
 		currentVersion: u,
 		isBreaking: !1,
 		hasUpdate: !1,
-		latestVersion: s,
+		latestVersion: a,
 		publishedAt: l,
 		skipReason: m,
 		latestSha: c,
-		action: e,
+		action: t,
 		status: p
 	};
 	if (d && isSha(d)) c ? h = !compareSha(d, c) : f && (h = !0);
 	else if (d && f) {
-		let n = semver.valid(d), r = semver.valid(f);
-		if (n && r) {
-			if (h = semver.lt(n, r), h) {
-				let e = semver.major(n);
-				g = semver.major(r) > e;
+		let e = semver.valid(d), n = semver.valid(f);
+		if (e && n) {
+			if (h = semver.lt(e, n), h) {
+				let t = semver.major(e);
+				g = semver.major(n) > t;
 			}
-			!h && semver.eq(n, r) && !isSha(e.version) && c && (h = !0, g = !1);
+			!h && semver.eq(e, n) && !isSha(t.version) && c && (h = !0, g = !1);
 		} else d !== f && (h = !0);
 	}
 	return {
 		currentVersion: u,
-		latestVersion: s,
+		latestVersion: a,
 		publishedAt: l,
 		isBreaking: g,
 		skipReason: m,
 		latestSha: c,
 		hasUpdate: h,
-		action: e,
+		action: t,
 		status: p
 	};
 }
@@ -209,21 +221,12 @@ function compareSha(e, t) {
 	let n = e.replace(/^v/u, ""), r = t.replace(/^v/u, ""), i = Math.min(n.length, r.length);
 	return i < 7 ? !1 : n.slice(0, Math.max(0, i)).toLowerCase() === r.slice(0, Math.max(0, i)).toLowerCase();
 }
-function normalizeVersion(e) {
-	if (!e) return null;
-	let n = e.replace(/^v/u, "");
-	if (/^[0-9a-f]{7,40}$/iu.test(n)) return e;
-	let r = semver.coerce(n);
-	return r ? r.version : e;
-}
 function isSha(e) {
 	if (!e) return !1;
 	let t = e.replace(/^v/u, "");
 	return /^[0-9a-f]{7,40}$/iu.test(t);
 }
-function isSemverLike(e) {
-	if (!e) return !1;
-	let t = e.trim();
-	return /^v?\d+(?:\.\d+){0,2}$/u.test(t);
+function isRateLimitError(e) {
+	return e instanceof Error && e.name === "GitHubRateLimitError";
 }
 export { checkUpdates };

package/dist/core/api/get-all-releases.d.ts

@@ -4,7 +4,8 @@ import { ReleaseInfo } from '../../types/release-info';
  * Fetch releases for a repository.
  *
  * Resolves SHA only for the first returned release via target_commitish when it
- * looks like a SHA; further enrichment happens at higher levels when needed.
+ * looks like a SHA; callers can resolve the tag via git refs later when
+ * pinning.
  *
  * @param context - Client context.
  * @param parameters - Request parameters.

package/dist/core/api/get-compatible-update.d.ts

@@ -0,0 +1,37 @@
+import { GitHubClient } from '../../types/github-client';
+import { UpdateMode } from '../../types/update-mode';
+import { TagInfo } from '../../types/tag-info';
+interface GetCompatibleUpdateParameters {
+    /**
+     * Optional in-memory cache for resolved tag SHAs.
+     */
+    shaCache?: Map<string, string | null>;
+    /**
+     * Update mode that limits which tag can be selected.
+     */
+    mode: Exclude<UpdateMode, 'major'>;
+    /**
+     * Optional in-memory cache for action tags.
+     */
+    tagsCache?: Map<string, TagInfo[]>;
+    /**
+     * Current action version used as compatibility baseline.
+     */
+    currentVersion: string | null;
+    /**
+     * Action name in `owner/repo` format (path suffix is allowed).
+     */
+    actionName: string;
+}
+/**
+ * Resolve the newest compatible update for an action.
+ *
+ * @param client - GitHub client instance.
+ * @param parameters - Lookup parameters.
+ * @returns Compatible target version and SHA, or null when none found.
+ */
+export declare function getCompatibleUpdate(client: GitHubClient, parameters: GetCompatibleUpdateParameters): Promise<{
+    sha: string | null;
+    version: string;
+} | null>;
+export {};

package/dist/core/api/get-compatible-update.js

@@ -0,0 +1,40 @@
+import { isSemverLike } from "../versions/is-semver-like.js";
+import { findCompatibleTag } from "../versions/find-compatible-tag.js";
+async function getCompatibleUpdate(n, r) {
+	let { currentVersion: i, actionName: a, mode: o } = r;
+	if (!i || !isSemverLike(i)) return null;
+	let s = a.split("/");
+	if (s.length < 2) return null;
+	let [c, l] = s;
+	if (!c || !l) return null;
+	let u = r.tagsCache ?? /* @__PURE__ */ new Map(), d = r.shaCache ?? /* @__PURE__ */ new Map(), f = u.get(a);
+	if (!f) {
+		try {
+			f = await n.getAllTags(c, l, 100);
+		} catch {
+			return null;
+		}
+		u.set(a, f);
+	}
+	let p = findCompatibleTag(f, i, o);
+	if (!p) return null;
+	let m = p.tag, h = p.sha?.length ? p.sha : null;
+	if (!h) {
+		let e = `${a}@${m}`;
+		if (d.has(e)) return {
+			sha: d.get(e) ?? null,
+			version: m
+		};
+		try {
+			h = await n.getTagSha(c, l, m);
+		} catch {
+			h = null;
+		}
+		d.set(e, h);
+	}
+	return {
+		version: m,
+		sha: h
+	};
+}
+export { getCompatibleUpdate };

package/dist/core/api/get-latest-release.d.ts

@@ -3,9 +3,9 @@ import { ReleaseInfo } from '../../types/release-info';
 /**
  * Fetch the latest release for a repository.
  *
- * If the latest release does not exist (404), returns null. The commit SHA is
- * taken from target_commitish only when it looks like a SHA; otherwise SHA is
- * left null and may be resolved later via tag lookups.
+ * If the latest release does not exist (404), returns null. The commit SHA may
+ * be taken from target_commitish when it looks like a SHA; callers can resolve
+ * the tag via git refs later when pinning.
  *
  * @param context - Client context.
  * @param owner - Repository owner.

package/dist/core/ast/utils/extract-uses-from-steps.d.ts

@@ -1,12 +1,20 @@
 import { GitHubAction } from '../../../types/github-action';
 interface ExtractUsesOptions {
-    /** YAML sequence node containing workflow/action steps. */
+    /**
+     * YAML sequence node containing workflow/action steps.
+     */
     stepsNode: unknown;
-    /** Path of the file being scanned (for metadata). */
+    /**
+     * Path of the file being scanned (for metadata).
+     */
     filePath: string;
-    /** Name of the job containing these steps (for workflows). */
+    /**
+     * Name of the job containing these steps (for workflows).
+     */
     jobName?: string;
-    /** Original YAML file content (for line number calculation). */
+    /**
+     * Original YAML file content (for line number calculation).
+     */
     content: string;
 }
 /**

package/dist/core/constants.d.ts

@@ -1,4 +1,6 @@
-/** Constants for directory names used in the project. */
+/**
+ * Constants for directory names used in the project.
+ */
 export declare const GITHUB_DIRECTORY: ".github";
 export declare const WORKFLOWS_DIRECTORY: "workflows";
 export declare const ACTIONS_DIRECTORY: "actions";

package/dist/core/fs/find-yaml-files-recursive.js

@@ -1,6 +1,6 @@
 import { isYamlFile } from "./is-yaml-file.js";
-import { join } from "node:path";
 import { lstat, readdir } from "node:fs/promises";
+import { join } from "node:path";
 async function findYamlFilesRecursive(i) {
 	let a = [], o = /* @__PURE__ */ new Set();
 	async function s(i) {

package/dist/core/interactive/prompt-update-selection.d.ts

@@ -1,6 +1,8 @@
 import { ActionUpdate } from '../../types/action-update';
 interface PromptUpdateSelectionOptions {
-    /** Whether to show the Age column. */
+    /**
+     * Whether to show the Age column.
+     */
     showAge?: boolean;
 }
 export declare function promptUpdateSelection(updates: ActionUpdate[], options?: PromptUpdateSelectionOptions): Promise<ActionUpdate[] | null>;

package/dist/core/interactive/prompt-update-selection.js

@@ -4,10 +4,10 @@ import { GITHUB_DIRECTORY } from "../constants.js";
 import { isSha } from "../versions/is-sha.js";
 import { stripAnsi } from "./strip-ansi.js";
 import { padString } from "./pad-string.js";
-import path from "node:path";
 import "node:worker_threads";
 import pc from "picocolors";
 import enquirer from "enquirer";
+import path from "node:path";
 var MIN_ACTION_WIDTH = 40, MIN_JOB_WIDTH = 4, MIN_CURRENT_WIDTH = 16, MAX_VERSION_WIDTH = 7;
 async function promptUpdateSelection(g, v = {}) {
 	let { showAge: y = !1 } = v;
@@ -41,8 +41,8 @@ async function promptUpdateSelection(g, v = {}) {
 		};
 	})), C = [], w = stripAnsi("Action").length, T = stripAnsi("Current").length, E = stripAnsi("Job").length, D = 0, O = !1;
 	for (let [t, a] of b.entries()) {
-		let o = a.action.name, l = S[t], d = l.display, f = a.action.job ?? "–";
-		if (w = Math.max(w, o.length), T = Math.max(T, stripAnsi(d).length, l.versionForPadding && l.shortSha ? stripAnsi(`${padString(l.versionForPadding, D + 1)}${pc.gray(`(${l.shortSha})`)}`).length : 0), E = Math.max(E, f.length), a.latestVersion) {
+		let o = a.action.name, u = S[t], d = u.display, f = a.action.job ?? "–";
+		if (w = Math.max(w, o.length), T = Math.max(T, stripAnsi(d).length, u.versionForPadding && u.shortSha ? stripAnsi(`${padString(u.versionForPadding, D + 1)}${pc.gray(`(${u.shortSha})`)}`).length : 0), E = Math.max(E, f.length), a.latestVersion) {
 			let o = formatVersion(a.latestVersion, S[t]?.effectiveForDiff ?? a.currentVersion);
 			D = Math.max(D, stripAnsi(o).length);
 		}
@@ -56,7 +56,7 @@ async function promptUpdateSelection(g, v = {}) {
 			console.warn(`Unexpected missing group for file: ${a}`);
 			continue;
 		}
-		let s = [], l = o;
+		let s = [], u = o;
 		s.push({
 			current: "Current",
 			action: "Action",
@@ -65,10 +65,10 @@ async function promptUpdateSelection(g, v = {}) {
 			job: "Job",
 			age: "Age"
 		});
-		for (let { update: t, index: a } of l) {
-			let o = !!t.latestSha, l = S[a], d = l.display;
-			l.versionForPadding && l.shortSha && (d = `${padString(l.versionForPadding, M + 1)}${pc.gray(`(${l.shortSha})`)}`);
-			let f = l.effectiveForDiff ?? t.currentVersion, p = formatVersion(t.latestVersion, f), m = t.action.name;
+		for (let { update: t, index: a } of u) {
+			let o = !!t.latestSha, u = S[a], d = u.display;
+			u.versionForPadding && u.shortSha && (d = `${padString(u.versionForPadding, M + 1)}${pc.gray(`(${u.shortSha})`)}`);
+			let f = u.effectiveForDiff ?? t.currentVersion, p = formatVersion(t.latestVersion, f), m = t.action.name;
 			if (t.latestSha) {
 				let i = t.latestSha.slice(0, 7);
 				p = `${padString(p, M + 1)}${pc.gray(`(${i})`)}`;
@@ -101,7 +101,7 @@ async function promptUpdateSelection(g, v = {}) {
 				name: ""
 			});
 			else {
-				let { update: i, index: a } = l[t - 1], s = !!i.latestSha, c = s && !i.isBreaking;
+				let { update: i, index: a } = u[t - 1], s = !!i.latestSha, c = s && !i.isBreaking;
 				_.push({
 					message: o,
 					value: String(a),

package/dist/core/parsing/parse-action-reference.d.ts

@@ -4,18 +4,22 @@ import { GitHubAction } from '../../types/github-action';
  * object.
  *
  * @example
- *   const action = parseActionReference(
- *     'actions/checkout@v3',
- *     'workflow.yml',
- *     10,
- *   )
- *   // Returns: {
- *   //   type: 'external',
- *   //   name: 'actions/checkout',
- *   //   version: 'v3',
- *   //   file: 'workflow.yml',
- *   //   line: 10,
- *   // }
+ *
+ * ```ts
+ * const action = parseActionReference(
+ *   'actions/checkout@v3',
+ *   'workflow.yml',
+ *   10,
+ * )
+ * // Returns:
+ * // {
+ * //   type: 'external',
+ * //   name: 'actions/checkout',
+ * //   version: 'v3',
+ * //   file: 'workflow.yml',
+ * //   line: 10,
+ * // }
+ * ```
  *
  * @param reference - The action reference string to parse. Can be:
  *

package/dist/core/scan-github-actions.d.ts

@@ -4,7 +4,10 @@ import { ScanResult } from '../types/scan-result';
  * actions.
  *
  * @example
- *   const result = await scanGitHubActions('/path/to/repo')
+ *
+ * ```ts
+ * const result = await scanGitHubActions('/path/to/repo')
+ * ```
  *
  * @param rootPath - The root path of the repository to scan. Defaults to
  *   current working directory.