Skip to content

feat(changelog): expose machine-readable endpoint for AI tools#7890

Merged
aidankmcalister merged 1 commit intomainfrom
feat/expose-changelog-to-ai
May 11, 2026
Merged

feat(changelog): expose machine-readable endpoint for AI tools#7890
aidankmcalister merged 1 commit intomainfrom
feat/expose-changelog-to-ai

Conversation

@aidankmcalister
Copy link
Copy Markdown
Member

@aidankmcalister aidankmcalister commented May 11, 2026

Adds /changelog.md — a plain-text markdown index of all Prisma changelog
entries that AI tools can fetch to check for recent breaking changes before
implementing Prisma features.

Updates site and docs llms.txt surfaces to reference the changelog and include
guidance to verify against it before relying on training data.

Linear: DR-8494

Summary by CodeRabbit

  • New Features

    • Added a machine-readable changelog endpoint accessible to AI language models.
    • Introduced warning notices advising readers to verify Prisma information against the latest changelog and official documentation before implementation.
  • Documentation

    • Integrated changelog references and links into LLM-accessible content pages for improved information accuracy.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment May 11, 2026 0:59am
docs Ready Ready Preview, Comment May 11, 2026 0:59am
eclipse Ready Ready Preview, Comment May 11, 2026 0:59am
site Ready Ready Preview, Comment May 11, 2026 0:59am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Walkthrough

This PR introduces a machine-readable changelog endpoint (/changelog.md) that generates a Markdown index of release notes, integrates changelog references and links into LLM-facing content across both docs and site domains, and adds changelog-checking guidance to plaintext LLM outputs.

Changes

Changelog LLM Content Support

Layer / File(s) Summary
Changelog Markdown Route
apps/site/src/app/changelog.md/route.ts
New GET handler generates a Markdown changelog index by fetching sorted release notes, deriving preview text (from summary, description, or fetched via getReleaseNotePreview), formatting each entry with version, title, date, optional tags, and URL, and returning the assembled Markdown document with Content-Type: text/markdown; charset=utf-8. Route disables ISR via revalidate = false.
LLM Content Integration
apps/site/src/app/llms-content.ts
Adds /changelog to sitePages with dedicated title and description. Extends buildLlmsIndexContent() with a changelog-referencing notice and /changelog.md machine-readable link in the Options section. Inserts a new "## Changelog" section into buildLlmsFullContent() with changelog URL, machine-readable index URL, and explicit instructions to fetch and consult the index.
Docs-side Changelog References
apps/docs/src/lib/llms.ts, apps/docs/src/app/llms.txt/route.ts
Adds a changelog query link to the exported commonQueries array as the first entry. Prepends a multi-line disclaimer notice to the llms.txt route output, warning about Prisma's frequent changes and advising readers to check the changelog and current docs before relying on training data.

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main purpose of the PR: exposing a machine-readable changelog endpoint for AI tools, which directly aligns with the primary changes across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/site/src/app/changelog.md/route.ts`:
- Around line 15-23: The Promise.all over entries can reject if any
getReleaseNotePreview fails, so change the entries.map handler in
entriesWithPreview to catch preview errors per entry: when computing summary (in
the async callback that references getReleaseNotePreview), wrap the await
getReleaseNotePreview(...) in a try/catch (or use Promise.allSettled for the
previews) and on error return null/empty for that entry’s summary; keep the rest
of the entry processing unchanged so a single preview failure no longer rejects
the whole Promise.all.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 919ca8a8-7ffb-4423-b025-7076ea45ea74

📥 Commits

Reviewing files that changed from the base of the PR and between d0a17f2 and d346d0a.

📒 Files selected for processing (4)
  • apps/docs/src/app/llms.txt/route.ts
  • apps/docs/src/lib/llms.ts
  • apps/site/src/app/changelog.md/route.ts
  • apps/site/src/app/llms-content.ts

Comment thread apps/site/src/app/changelog.md/route.ts
@argos-ci
Copy link
Copy Markdown

argos-ci Bot commented May 11, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - May 11, 2026, 1:06 AM

@aidankmcalister aidankmcalister merged commit 44260d3 into main May 11, 2026
16 checks passed
@aidankmcalister aidankmcalister deleted the feat/expose-changelog-to-ai branch May 11, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants