Skip to content

fix(publish): say the diff is unavailable rather than claiming no changes #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dean-harel-unipaas merged 1 commit into from
Aug 29, 2026
Merged

fix(publish): say the diff is unavailable rather than claiming no changes #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions scripts/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,19 @@ async function main(): Promise<void> {
if (stage === 'changed') {
const tag = releaseTag({ infoVersion: incoming.info.version, isoDate, sha });
// Build a changelog entry by diffing the previous published spec (still on disk) against the
// incoming one, before the overwrite. Best effort: if oasdiff is unavailable or errors, fall back
// to a neutral note rather than fail the publish.
// incoming one, before the overwrite. Best effort: a broken oasdiff must not fail the publish.
// Empty output and a crash are different facts, so they get different text: this branch only runs
// when the spec provably changed, so claiming no changes because the differ died would put a
// false statement into a public changelog and a release body.
let diffBody = 'Initial published spec.';
if (fs.existsSync(SPEC_JSON)) {
try {
diffBody =
capture('oasdiff', ['changelog', SPEC_JSON, specPath, '-f', 'markdown']).trim() ||
'No API-surface changes detected.';
} catch {
diffBody = 'No API-surface changes detected.';
} catch (err) {
console.error(`oasdiff failed, publishing without a diff: ${err instanceof Error ? err.message : err}`);
diffBody = 'Diff unavailable: the spec changed, but oasdiff did not run.';
}
}
const entry = `## ${tag} (${isoDate.slice(0, 10)})\n\n${diffBody}\n`;
Expand Down
Loading