@stacksjs/actions 0.75.257 → 0.75.258

package/dist/release-notes.d.ts

@@ -0,0 +1,79 @@
+import type { CommitInfo } from '@stacksjs/logsmith';
+/**
+ * The notes for these commits, grouped the way logsmith groups a changelog.
+ * Empty when none of them is something a tester sees.
+ */
+export declare function testerNotes(commits: CommitInfo[], options?: TesterNotesOptions): string;
+/**
+ * Notes cut to `limit` characters on whole lines, saying how many items were
+ * left out ("…and 12 more"). A section heading whose items were all cut goes
+ * too; a single line longer than the limit is cut at a word.
+ */
+export declare function fitNotes(text: string, limit: number): string;
+/** The newest mobile release tag (`v*-build.*`) at or before `ref`. */
+export declare function previousMobileTag(cwd: string, ref?: string): string | undefined;
+/** The conventional commits in `from..to`, parsed by logsmith. */
+export declare function commitsBetween(cwd: string, from: string | undefined, to?: string): CommitInfo[];
+/**
+ * The notes for a release and where they came from: `--notes`/`--notes-file`,
+ * then RELEASE_NOTES/RELEASE_NOTES_FILE, then config/mobile.ts, then generated.
+ */
+export declare function resolveNotes(options: ResolveNotesOptions): { text: string, source: NotesSource };
+/**
+ * App Store locales for the app's languages (`en` → `en-US`, `de` → `de-DE`),
+ * always with `en-US` first, the locale an app without localizations uses.
+ */
+export declare function appStoreLocales(languages: string[] | undefined): string[];
+/**
+ * Write `TestFlight/WhatToTest.<locale>.txt` beside the Xcode project, where
+ * Xcode Cloud reads it when it uploads the build to TestFlight. Returns the
+ * files written, relative to `root`.
+ */
+export declare function writeWhatToTest(root: string, projectDir: string, notes: string, locales: string[]): string[];
+/** The What to Test a tag shipped with, as committed beside its Xcode project. */
+export declare function committedWhatToTest(cwd: string, tag: string, projectDir: string, locale?: string): string | null;
+/** App Store Connect's limit on a build's "What to Test". */
+export declare const TESTFLIGHT_NOTES_LIMIT: 4000;
+/**
+ * The cap for `TestFlight/WhatToTest.<locale>.txt`. Apple documents 4000
+ * characters for the field, but Xcode Cloud has been seen to log "Found notes"
+ * and then show nothing for a file over about 2 KB (developer forums, thread
+ * 810627), so the file stays well under that. The App Store Connect API path
+ * (`--wait`, `buddy release:notes --testflight`) sets the full 4000.
+ */
+export declare const XCODE_CLOUD_NOTES_LIMIT: 1000;
+/** Google Play's limit on a release's "What's new", per language. */
+export declare const PLAY_NOTES_LIMIT: 500;
+/**
+ * The commit types a tester notices, in the order bumpx's changelog lists them.
+ * @defaultValue `['feat', 'fix', 'perf', 'revert']`
+ */
+export declare const DEFAULT_NOTE_TYPES: string[];
+/**
+ * Scopes that never describe something a tester sees.
+ * @defaultValue `['release', 'ci', 'deps', 'deps-dev', 'test', 'tests', 'docs', 'lint']`
+ */
+export declare const DEFAULT_EXCLUDED_SCOPES: string[];
+/** What testers read when nothing since the last build is theirs to see. */
+export declare const NO_VISIBLE_CHANGES: 'Maintenance build: no visible changes since the previous build.';
+/** What `config/mobile.ts` may say about release notes (`MobileConfig.release`). */
+export declare interface ReleaseNotesConfig {
+  notes?: string
+  notesFile?: string
+  noteTypes?: string[]
+  excludeScopes?: string[]
+  locales?: string[]
+}
+export declare interface TesterNotesOptions {
+  types?: string[]
+  excludeScopes?: string[]
+  markdown?: boolean
+}
+export declare interface ResolveNotesOptions {
+  cwd: string
+  flags?: { notes?: string, notesFile?: string }
+  env?: Record<string, string | undefined>
+  config?: ReleaseNotesConfig
+  generate: () => string
+}
+export type NotesSource = 'flag' | 'env' | 'config' | 'generated';

package/dist/release-notes.js

@@ -0,0 +1,9 @@
+import{existsSync,mkdirSync,readFileSync,writeFileSync}from"node:fs";import{isAbsolute,join,relative}from"node:path";import{defaultConfig,getCommits,groupCommits}from"@stacksjs/logsmith";export const TESTFLIGHT_NOTES_LIMIT=4000,XCODE_CLOUD_NOTES_LIMIT=1000,PLAY_NOTES_LIMIT=500,DEFAULT_NOTE_TYPES=["feat","fix","perf","revert"],DEFAULT_EXCLUDED_SCOPES=["release","ci","deps","deps-dev","test","tests","docs","lint"];const SECTION_TITLES={feat:"Features",fix:"Fixes",perf:"Performance",refactor:"Changes",revert:"Reverted",style:"Styles",build:"Build",docs:"Documentation"},BANG=/^(\w+)(?:\(([^)]+)\))?!: (.+)$/;function normalized(commit){const bang=commit.type==="misc"?BANG.exec(commit.message):null;return bang?{...commit,type:bang[1],scope:bang[2]||void 0,description:bang[3],breaking:!0}:commit}function line(description,scope){const text=description.replace(/\s*\((?:#\d+(?:,\s*)?)+\)\s*$/,"").replace(/\s+/g," ").trim(),sentence=text.charAt(0).toUpperCase()+text.slice(1),context=scope?.split(",").map((part)=>part.trim()).filter(Boolean).join(", ");return context?`${sentence} (${context})`:sentence}export function testerNotes(commits,options={}){const types=options.types?.length?options.types:DEFAULT_NOTE_TYPES,sections=groupCommits(commits.map(normalized),{...defaultConfig,verbose:!1,includeCommitTypes:types,excludeCommitTypes:[],excludeScopes:options.excludeScopes??DEFAULT_EXCLUDED_SCOPES,includeScopes:[],excludeAuthors:[],includeAuthors:[],excludeMessages:[],groupBreakingChanges:!1,maxCommitsPerSection:0,minCommitsForSection:1,maxDescriptionLength:0}),blocks=[];for(const section of sections){const type=section.commits[0]?.type??"",seen=new Set,lines=section.commits.map((entry)=>line(entry.description,entry.scope)).filter((text)=>text&&!seen.has(text.toLowerCase())&&seen.add(text.toLowerCase())).map((text)=>`- ${text}`);if(!lines.length)continue;const title=SECTION_TITLES[type]??type.charAt(0).toUpperCase()+type.slice(1);blocks.push([options.markdown?`**${title}**`:title,...options.markdown?[""]:[],...lines].join(`
+`))}return blocks.join(`
+
+`)}export const NO_VISIBLE_CHANGES="Maintenance build: no visible changes since the previous build.";export function fitNotes(text,limit){const notes=text.trim();if(notes.length<=limit)return notes;const lines=notes.split(`
+`),isItem=(value)=>/^\s*(?:[-*\u2022]|\d+\.)\s/.test(value),suffix=(omitted)=>omitted>0?`
+\u2026and ${omitted} more`:"\u2026",kept=[];let index=0;for(;index<lines.length;index++){const rest=lines.slice(index+1).filter(isItem).length;if([...kept,lines[index]].join(`
+`).length+suffix(rest).length>limit)break;kept.push(lines[index])}const trim=()=>{while(kept.length&&!kept[kept.length-1].trim())kept.pop()};trim();if(kept.length&&!isItem(kept[kept.length-1])&&lines[kept.length]!==void 0&&isItem(lines[kept.length])&&kept.some(isItem)){kept.pop();trim()}const omitted=lines.slice(kept.length).filter(isItem).length;if(!kept.length||omitted===0&&!kept.some(isItem)){const room=limit-1,cut=notes.slice(0,room),word=cut.lastIndexOf(" ");return`${(word>room/2?cut.slice(0,word):cut).trimEnd()}\u2026`}return`${kept.join(`
+`)}${suffix(omitted)}`}function git(cwd,args){const result=Bun.spawnSync(["git",...args],{cwd,stdout:"pipe",stderr:"ignore"});return result.exitCode===0?result.stdout.toString().trim():null}export function previousMobileTag(cwd,ref="HEAD"){return git(cwd,["describe","--tags","--match","v*-build.*","--abbrev=0",ref])||void 0}export function commitsBetween(cwd,from,to="HEAD"){return getCommits(from,to,cwd)}function readNotesFile(cwd,path,origin){const absolute=isAbsolute(path)?path:join(cwd,path);if(!existsSync(absolute))throw Error(`${origin} names ${path}, which does not exist`);return readFileSync(absolute,"utf8")}export function resolveNotes(options){const{cwd,flags={},env=process.env,config={}}=options,pick=(text,file,origin,source)=>{if(text?.trim()&&file?.trim())throw Error(`give either ${origin[0]} or ${origin[1]}, not both`);const value=text?.trim()?text:file?.trim()?readNotesFile(cwd,file.trim(),origin[1]):void 0;return value?.trim()?{text:value.trim(),source}:null},notes=typeof flags.notes==="string"?flags.notes:void 0,notesFile=typeof flags.notesFile==="string"?flags.notesFile:void 0;return pick(notes,notesFile,["--notes","--notes-file"],"flag")??pick(env.RELEASE_NOTES,env.RELEASE_NOTES_FILE,["RELEASE_NOTES","RELEASE_NOTES_FILE"],"env")??pick(config.notes,config.notesFile,["release.notes","release.notesFile"],"config")??{text:options.generate().trim()||NO_VISIBLE_CHANGES,source:"generated"}}const APP_STORE_LOCALES={en:"en-US",de:"de-DE",fr:"fr-FR",es:"es-ES",nl:"nl-NL",pt:"pt-BR",zh:"zh-Hans"};export function appStoreLocales(languages){const locales=(languages??[]).map((language)=>language.trim().replace("_","-")).filter(Boolean).map((language)=>language.includes("-")?language:APP_STORE_LOCALES[language.toLowerCase()]??language.toLowerCase());return[...new Set(["en-US",...locales])]}export function writeWhatToTest(root,projectDir,notes,locales){const dir=join(isAbsolute(projectDir)?projectDir:join(root,projectDir),"TestFlight");mkdirSync(dir,{recursive:!0});const text=`${fitNotes(notes,XCODE_CLOUD_NOTES_LIMIT)}
+`;return locales.map((locale)=>{const path=join(dir,`WhatToTest.${locale}.txt`);writeFileSync(path,text);return relative(root,path)})}export function committedWhatToTest(cwd,tag,projectDir,locale="en-US"){const path=`${projectDir.replace(/\/$/,"")}/TestFlight/WhatToTest.${locale}.txt`;return git(cwd,["show",`${tag}:${path}`])}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/actions",
   "type": "module",
   "sideEffects": false,
-  "version": "0.75.257",
+  "version": "0.75.258",
   "description": "The Stacks actions.",
   "author": "Chris Breuer",
   "contributors": [
@@ -66,54 +66,54 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/action-runner": "0.75.257",
-    "@stacksjs/ai": "0.75.257",
-    "@stacksjs/analytics": "0.75.257",
-    "@stacksjs/api": "0.75.257",
-    "@stacksjs/auth": "0.75.257",
-    "@stacksjs/build": "0.75.257",
+    "@stacksjs/action-runner": "0.75.258",
+    "@stacksjs/ai": "0.75.258",
+    "@stacksjs/analytics": "0.75.258",
+    "@stacksjs/api": "0.75.258",
+    "@stacksjs/auth": "0.75.258",
+    "@stacksjs/build": "0.75.258",
     "@stacksjs/bumpx": "^0.2.25",
     "@stacksjs/bunpress": "^0.2.15",
-    "@stacksjs/cli": "0.75.257",
-    "@stacksjs/cloud": "0.75.257",
-    "@stacksjs/cms": "0.75.257",
+    "@stacksjs/cli": "0.75.258",
+    "@stacksjs/cloud": "0.75.258",
+    "@stacksjs/cms": "0.75.258",
     "@stacksjs/components": "0.2.644",
-    "@stacksjs/config": "0.75.257",
-    "@stacksjs/database": "0.75.257",
-    "@stacksjs/desktop-build": "0.75.257",
-    "@stacksjs/dns": "0.75.257",
-    "@stacksjs/enums": "0.75.257",
-    "@stacksjs/env": "0.75.257",
-    "@stacksjs/error-handling": "0.75.257",
-    "@stacksjs/github": "0.75.257",
+    "@stacksjs/config": "0.75.258",
+    "@stacksjs/database": "0.75.258",
+    "@stacksjs/desktop-build": "0.75.258",
+    "@stacksjs/dns": "0.75.258",
+    "@stacksjs/enums": "0.75.258",
+    "@stacksjs/env": "0.75.258",
+    "@stacksjs/error-handling": "0.75.258",
+    "@stacksjs/github": "0.75.258",
     "@stacksjs/gitit": "^0.2.5",
-    "@stacksjs/i18n": "0.75.257",
-    "@stacksjs/image": "0.75.257",
-    "@stacksjs/logging": "0.75.257",
+    "@stacksjs/i18n": "0.75.258",
+    "@stacksjs/image": "0.75.258",
+    "@stacksjs/logging": "0.75.258",
     "@stacksjs/logsmith": "^0.2.11",
-    "@stacksjs/mobile": "0.75.257",
-    "@stacksjs/orm": "0.75.257",
-    "@stacksjs/path": "0.75.257",
-    "@stacksjs/payments": "0.75.257",
-    "@stacksjs/queue": "0.75.257",
-    "@stacksjs/registry": "0.75.257",
-    "@stacksjs/router": "0.75.257",
+    "@stacksjs/mobile": "0.75.258",
+    "@stacksjs/orm": "0.75.258",
+    "@stacksjs/path": "0.75.258",
+    "@stacksjs/payments": "0.75.258",
+    "@stacksjs/queue": "0.75.258",
+    "@stacksjs/registry": "0.75.258",
+    "@stacksjs/router": "0.75.258",
     "@stacksjs/rpx": "^0.11.54",
-    "@stacksjs/scheduler": "0.75.257",
-    "@stacksjs/search-engine": "0.75.257",
-    "@stacksjs/security": "0.75.257",
-    "@stacksjs/server": "0.75.257",
-    "@stacksjs/sites": "0.75.257",
-    "@stacksjs/storage": "0.75.257",
-    "@stacksjs/strings": "0.75.257",
+    "@stacksjs/scheduler": "0.75.258",
+    "@stacksjs/search-engine": "0.75.258",
+    "@stacksjs/security": "0.75.258",
+    "@stacksjs/server": "0.75.258",
+    "@stacksjs/sites": "0.75.258",
+    "@stacksjs/storage": "0.75.258",
+    "@stacksjs/strings": "0.75.258",
     "@stacksjs/stx": "0.2.644",
     "@stacksjs/tlsx": "^0.13.19",
     "@stacksjs/ts-cloud": "^0.16.58",
     "@stacksjs/ts-md": "^0.1.1",
-    "@stacksjs/tunnel": "0.75.257",
-    "@stacksjs/types": "0.75.257",
-    "@stacksjs/utils": "0.75.257",
-    "@stacksjs/whois": "0.75.257",
+    "@stacksjs/tunnel": "0.75.258",
+    "@stacksjs/types": "0.75.258",
+    "@stacksjs/utils": "0.75.258",
+    "@stacksjs/whois": "0.75.258",
     "bun-plugin-stx": "0.2.644"
   },
   "peerDependencies": {
@@ -129,7 +129,7 @@
     }
   },
   "devDependencies": {
-    "@stacksjs/validation": "0.75.257",
+    "@stacksjs/validation": "0.75.258",
     "better-dx": "^0.2.24"
   }
 }