shipseal 0.4.0 → 0.4.2

package/README.md

@@ -49,7 +49,7 @@ jobs:
     steps:
       - uses: actions/checkout@v7
         with: { fetch-depth: 0 }
-      - uses: akii09/shipseal@v0.4.0
+      - uses: akii09/shipseal@v0.4.2
         env: { GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" }
 ```
 

package/dist/cli.js

@@ -325,6 +325,24 @@ const COPY_LIMITS = {
 	milestoneLine: 48
 };
 
+//#endregion
+//#region src/copy/headline.ts
+/** Below this a line is a fragment or a label, not a description of a change. */
+const MIN_WORDS = 3;
+const MIN_CHARS = 12;
+/** Housekeeping prefixes. A chore is not what a release is about. */
+const CHORE = /^(chore|docs?|ci|build|test|refactor|style|revert|bump|deps?|dependencies)\b[:(]?/i;
+/** A line that is only a person's name: "Adam Chmara", "Jane Q. Smith". */
+const PERSON_NAME = /^[A-Z][\p{L}'’-]+(?:\s+[A-Z][.\p{L}'’-]*){1,2}$/u;
+/** Package-ish fragments: "/api", "@scope/pkg", "solid-query.0.0-rc.3", "v1.2.3". */
+const FRAGMENT = /^[@/]|^v?\d+\.\d+|^[\w@/.-]+$/;
+function isHeadlineWorthy(line) {
+	const text = line.trim();
+	if (text.length < MIN_CHARS || text.split(/\s+/).length < MIN_WORDS) return false;
+	if (CHORE.test(text) || PERSON_NAME.test(text) || FRAGMENT.test(text)) return false;
+	return !/https?:\/\//.test(text);
+}
+
 //#endregion
 //#region src/copy/deterministic.ts
 function deterministicCopy(facts, maxHighlights = 4, displayName) {
@@ -333,7 +351,7 @@ function deterministicCopy(facts, maxHighlights = 4, displayName) {
 	const features = (facts.release?.features ?? []).map((item) => item.value);
 	const fixes = (facts.release?.fixes ?? []).map((item) => item.value);
 	const breaking = (facts.release?.breaking ?? []).map((item) => item.value);
-	const headlineSource = [...breaking, ...features].map((line) => cleanLine(firstSentence(line))).find((line) => line.length <= HEADLINE_MAX_CHARS);
+	const headlineSource = [...breaking, ...features].map((line) => cleanLine(firstSentence(line))).find((line) => line.length <= HEADLINE_MAX_CHARS && isHeadlineWorthy(line));
 	const title = displayName ?? name;
 	const headline = facts.release?.headline?.value ?? headlineSource ?? (version === void 0 ? title : `${title} ${version}`);
 	const tagline = facts.release?.subheadline?.value ?? facts.project.tagline?.value;
@@ -2529,7 +2547,7 @@ function stripBadges(text) {
 /** Markdown escapes a maintainer never meant to see rendered: \[ruff\] becomes [ruff]. */
 const MARKDOWN_ESCAPE = /\\([[\]()*_`~#+\-.!])/g;
 function cleanReleaseLine(item) {
-	return item.replace(/^\s*[-*]\s*/, "").replace(/\[`[a-f0-9]{7,40}`]\([^)]+\)/gi, "").replace(/^[a-f0-9]{7,40}:\s*/i, "").replace(/\(#\d+\)/g, "").replace(/\[#\d+]\([^)]+\)/g, "").replace(/#\d+\b/g, "").replace(/Thanks\s+\[@[\w-]+]\([^)]+\)!?\s*-?\s*/gi, "").replace(/\[@[\w-]+]\([^)]+\)/g, "").replace(/\(@[\w-]+\)/g, "").replace(/\s+by\s+@[\w-]+/gi, "").replace(/@[\w-]+/g, "").replace(/^Thanks\s*!?\s*-?\s*/i, "").replaceAll(/!\[[^\]]*\]\([^)]*\)/g, "").replaceAll(/\[([^\]]+)\]\([^)]*\)/g, "$1").replaceAll(/<[^>]*>/g, "").replaceAll(MARKDOWN_ESCAPE, "$1").replaceAll(/[*`]/g, "").replace(/^\s*[-*]\s*/, "").replace(/\s*\(\s*\)/g, "").replace(/\s+([,.;:])/g, "$1").replace(/\s+/g, " ").trim().replace(/[\s,;:-]+$/, "").replace(/\.$/, "");
+	return item.replace(/^\s*[-*]\s*/, "").replace(/\[`[a-f0-9]{7,40}`]\([^)]+\)/gi, "").replace(/^[a-f0-9]{7,40}:\s*/i, "").replace(/\(#\d+\)/g, "").replace(/\[#\d+]\([^)]+\)/g, "").replace(/#\d+\b/g, "").replace(/Thanks\s+\[@[\w-]+]\([^)]+\)!?\s*-?\s*/gi, "").replace(/\[@[\w-]+]\([^)]+\)/g, "").replace(/\(@[\w-]+\)/g, "").replace(/\s+by\s+@[\w-]+/gi, "").replace(/@[\w-]+/g, "").replace(/^Thanks\s*!?\s*-?\s*/i, "").replaceAll(/!\[[^\]]*\]\([^)]*\)/g, "").replaceAll(/\[([^\]]+)\]\([^)]*\)/g, "$1").replaceAll(/<[^>]*>/g, "").replaceAll(MARKDOWN_ESCAPE, "$1").replaceAll(/[*`]/g, "").replaceAll(/\(\s*[a-f0-9]{6,40}\s*\)/gi, "").replace(/^\[[^\]]{1,24}\]\s*/, "").replace(/^\s*[-*]\s*/, "").replace(/\s*\(\s*\)/g, "").replace(/\s+([,.;:])/g, "$1").replace(/\s+/g, " ").trim().replace(/[\s,;:-]+$/, "").replace(/\.$/, "");
 }
 
 //#endregion