Skip to content

Cherry-pick: Constrain release-notes doc links to existing files #27

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
frontegg-david merged 1 commit into from
Aug 12, 2026
Merged

Cherry-pick: Constrain release-notes doc links to existing files #27

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
6 changes: 5 additions & 1 deletion .github/workflows/publish-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ jobs:
const fs = require('fs');
const diff = fs.readFileSync('/tmp/diff.txt', 'utf8');
const commits = fs.readFileSync('/tmp/commits.txt', 'utf8');
const docsFiles = fs.readdirSync('docs').filter((f) => f.endsWith('.md')).sort().join('\n');
const releaseDate = new Date().toISOString().split('T')[0];
const version = process.env.VERSION;
const versionNum = version.replace('v', '');
Expand All @@ -192,6 +193,9 @@ jobs:
${diff.substring(0, 40000)}
\`\`\`

Documentation files that exist in docs/ — the ONLY valid link targets; copy a filename from this list verbatim or do not link at all:
${docsFiles}

Generate four outputs as JSON: {"title": "...", "changelog": "...", "changelogEntry": "...", "cardMdx": "..."}

=== OUTPUT 1: "title" — a 3-6 word headline naming the flagship capability ===
Expand Down Expand Up @@ -228,7 +232,7 @@ jobs:
- Claim ONLY what the commit subjects and diff show. Never invent features, API names, numbers, or benchmarks.
- Lead with the user-facing benefit; implementation detail comes second or not at all.
- Short, complete sentences. Ban filler ("various improvements", "minor fixes", "enhanced support").
- Link documentation with absolute URLs (https://github.com/agentfront/mcp-from-openapi/blob/main/docs/<file>.md) ONLY for doc files that actually appear in the diff — at most one links line.
- Link documentation with absolute URLs (https://github.com/agentfront/mcp-from-openapi/blob/main/docs/<file>.md) ONLY using filenames copied verbatim from the docs/ list above — NEVER guess or construct a filename; at most one links line.
- Behavior changes are sacred: if a default changed or output changed shape, it MUST appear in the ⚠️ table.

=== OUTPUT 3: "changelogEntry" — a Keep a Changelog section for CHANGELOG.md ===
Expand Down