Skip to content

feat(changelog): add GPT-5 models support and AI SDK Provider v2.0 release notes - #591

Merged
smakosh merged 3 commits into
mainfrom
feat/ai-sdk-2-changelog-release
Aug 7, 2025
Merged

smakosh merged 3 commits into
mainfrom
feat/ai-sdk-2-changelog-release

Conversation

@smakosh

@smakosh smakosh commented Aug 7, 2025

Copy link
Copy Markdown
Member

What's new

  • Introduced new changelog entries for the release of GPT-5 model family, detailing model specifications, pricing, and usage examples.
  • Added draft entry for AI SDK Provider v2.0, highlighting improved integration with Vercel AI SDK and simplified model access.
  • Updated content collections to include optional draft field for changelog entries.
  • Added new images for changelog entries.

This commit enhances the documentation and visibility of new features in the changelog.

Summary by CodeRabbit

  • New Features

    • Added new changelog entries announcing GPT-5 model family support and the release of AI SDK Provider v2, including detailed usage instructions and feature highlights.
  • Improvements

    • Changelog entries now support an optional "draft" status, and draft entries are excluded from the public changelog display.
    • Enhanced markdown rendering for changelog content with improved syntax highlighting and consistent styling for code blocks and other elements.
    • Updated model display order by reversing model lists without sorting within provider entries.
  • Refactor

    • Reorganized and updated markdown utility logic to improve maintainability and styling consistency.
    • Removed previous markdown styling module and replaced it with a new implementation featuring dual-theme syntax highlighting.

…lease notes

- Introduced new changelog entries for the release of GPT-5 model family, detailing model specifications, pricing, and usage examples.
- Added draft entry for AI SDK Provider v2.0, highlighting improved integration with Vercel AI SDK and simplified model access.
- Updated content collections to include optional draft field for changelog entries.
- Added new images for changelog entries.

This commit enhances the documentation and visibility of new features in the changelog.
@smakosh smakosh self-assigned this Aug 7, 2025
@coderabbitai

coderabbitai Bot commented Aug 7, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This change introduces an optional draft property to changelog entries in both the schema and type definitions. The changelog page now filters out draft entries before rendering. Two new changelog markdown files were added. The markdown rendering utility was refactored from a .ts to a .tsx file, adding syntax highlighting and updating type definitions.

Changes

Cohort / File(s) Change Summary
Changelog Schema & Types
apps/ui/content-collections.ts, apps/ui/src/types/content-collections.d.ts
Added an optional draft boolean property to the changelog schema and type definition, allowing changelog entries to be marked as drafts.
Changelog Page Filtering
apps/ui/src/app/changelog/page.tsx
Updated logic to filter out changelog entries marked as drafts before rendering, ensuring only non-draft entries are displayed.
Changelog Entries
apps/ui/src/content/changelog/2025-01-26-gpt-5-models-support.md, apps/ui/src/content/changelog/2025-08-07-ai-sdk-provider-v2.md
Added two new markdown changelog files: one announcing GPT-5 model support and another announcing the release of @llmgateway/ai-sdk-provider v2.0, each with detailed descriptions, usage examples, and relevant metadata.
Markdown Utility Refactor
apps/ui/src/lib/utils/markdown.ts, apps/ui/src/lib/utils/markdown.tsx
Deleted the previous markdown utility file (.ts) and replaced it with a new .tsx module. The new module introduces a custom SyntaxHighlightedPre React component for syntax-highlighted code blocks, redefines type interfaces, and updates markdown rendering options with Tailwind CSS classes and the new code block renderer.
Model Sorting Update
apps/ui/src/components/models-supported.tsx
Modified sorting logic for models within provider entries: removed sorting by model ID and instead reversed the order of the models array after sorting providers alphabetically by name. No signature or API changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChangelogPage
    participant ContentCollection
    participant MarkdownRenderer

    User->>ChangelogPage: Requests changelog page
    ChangelogPage->>ContentCollection: Fetch changelog entries
    ContentCollection-->>ChangelogPage: Return entries (some with draft: true)
    ChangelogPage->>ChangelogPage: Filter out draft entries
    ChangelogPage->>MarkdownRenderer: Render non-draft entries with markdown options
    MarkdownRenderer->>ChangelogPage: Rendered HTML with syntax highlighting
    ChangelogPage-->>User: Display filtered, rendered changelog
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Possibly related PRs

  • feat(changelog): implement changelog #373: Implements the initial changelog feature including schema, routes, components, and markdown rendering; this PR builds upon and modifies that implementation by adding draft support and filtering.

Suggested reviewers

  • steebchen

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c97be7f and b2fe4ab.

📒 Files selected for processing (1)
  • apps/ui/src/components/models-supported.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Use localStorage instead of cookies for client-side data persistence

Files:

  • apps/ui/src/components/models-supported.tsx
apps/ui/**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

In apps/ui (a tanstack router project), always use navigate() for navigation

Use localStorage instead of cookies for client-side data persistence

Files:

  • apps/ui/src/components/models-supported.tsx
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/general.mdc)

Never use as any or : any in TypeScript files.

Files:

  • apps/ui/src/components/models-supported.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build / run
🔇 Additional comments (1)
apps/ui/src/components/models-supported.tsx (1)

201-206: Validate model ordering behavior

The change replaces the previous alphabetical sort of each provider’s models by modelName with a simple .reverse(), relying on the export order from @llmgateway/models. To ensure predictable UX, please verify:

  • That each provider’s array in packages/models/src/models.ts (e.g. openaiModels, anthropicModels, etc.) appends new models at the end, so .reverse() will surface the newest entries first.
  • If a consistent (alphabetical) listing is still required, revert to:
    .map(([provider, models]) =>
      [provider, [...models].sort((a, b) => a.modelName.localeCompare(b.modelName))]
    )
  • Consider adding a brief comment explaining why .reverse() is used (e.g. “reverse to show newest models first”).

This will confirm the UI order matches the intended behavior.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/ai-sdk-2-changelog-release

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@steebchen steebchen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🚀🚀🚀🚀

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2c8e62 and c97be7f.

⛔ Files ignored due to path filters (3)
  • apps/ui/public/changelog/ai-sdk-provider-v2.png is excluded by !**/*.png
  • apps/ui/public/changelog/gpt-5-models.png is excluded by !**/*.png
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • apps/ui/content-collections.ts (1 hunks)
  • apps/ui/src/app/changelog/page.tsx (1 hunks)
  • apps/ui/src/content/changelog/2025-01-26-gpt-5-models-support.md (1 hunks)
  • apps/ui/src/content/changelog/2025-08-07-ai-sdk-provider-v2.md (1 hunks)
  • apps/ui/src/lib/utils/markdown.ts (0 hunks)
  • apps/ui/src/lib/utils/markdown.tsx (1 hunks)
  • apps/ui/src/types/content-collections.d.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • apps/ui/src/lib/utils/markdown.ts
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Use localStorage instead of cookies for client-side data persistence

Files:

  • apps/ui/src/app/changelog/page.tsx
  • apps/ui/content-collections.ts
  • apps/ui/src/types/content-collections.d.ts
  • apps/ui/src/lib/utils/markdown.tsx
apps/ui/**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

In apps/ui (a tanstack router project), always use navigate() for navigation

Use localStorage instead of cookies for client-side data persistence

Files:

  • apps/ui/src/app/changelog/page.tsx
  • apps/ui/content-collections.ts
  • apps/ui/src/types/content-collections.d.ts
  • apps/ui/src/lib/utils/markdown.tsx
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/general.mdc)

Never use as any or : any in TypeScript files.

Files:

  • apps/ui/src/app/changelog/page.tsx
  • apps/ui/content-collections.ts
  • apps/ui/src/types/content-collections.d.ts
  • apps/ui/src/lib/utils/markdown.tsx
**/*.{js,ts}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

**/*.{js,ts}: Use drizzle with the latest object syntax for database operations
For read queries, always use db().query.<table>.findMany() or db().query.<table>.findFirst()

Files:

  • apps/ui/content-collections.ts
  • apps/ui/src/types/content-collections.d.ts
🧬 Code Graph Analysis (1)
apps/ui/src/app/changelog/page.tsx (1)
apps/ui/src/types/content-collections.d.ts (1)
  • Changelog (2-16)
🪛 Gitleaks (8.27.2)
apps/ui/src/content/changelog/2025-01-26-gpt-5-models-support.md

61-62: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.

(curl-auth-header)

🔇 Additional comments (10)
apps/ui/src/app/changelog/page.tsx (1)

11-11: LGTM! Draft filtering implemented correctly.

The filter uses optional chaining to safely exclude draft entries, ensuring backward compatibility with existing changelog entries that don't have the draft property. The filtering is correctly applied after sorting but before mapping.

apps/ui/content-collections.ts (1)

14-14: LGTM! Schema properly extended for draft support.

The optional boolean draft property is correctly implemented using Zod's optional() method, maintaining backward compatibility with existing changelog entries while enabling the new draft functionality.

apps/ui/src/types/content-collections.d.ts (1)

8-8: LGTM! Type definition properly aligned with schema.

The optional draft boolean property correctly matches the Zod schema definition and maintains type consistency across the codebase.

apps/ui/src/content/changelog/2025-08-07-ai-sdk-provider-v2.md (1)

1-63: LGTM! Well-structured changelog entry with appropriate draft status.

The changelog entry is comprehensive and well-formatted, including proper metadata, clear feature descriptions, and helpful code examples. The draft: true setting ensures this won't be displayed until ready for publication.

apps/ui/src/content/changelog/2025-01-26-gpt-5-models-support.md (2)

1-79: LGTM! Comprehensive changelog entry with excellent documentation.

The changelog entry provides thorough coverage of the GPT-5 model family with clear specifications, pricing details, and practical usage examples. The content structure and formatting are excellent.


61-62: Static analysis false positive - documentation example is safe.

The authorization header in the curl example uses placeholder text (YOUR_API_KEY) and is clearly documentation, not a real credential. This is standard practice for API documentation examples.

apps/ui/src/lib/utils/markdown.tsx (4)

1-191: Inconsistency between AI summary and actual file content.

The AI summary states this file was "deleted entirely," but the code shows a new file with complete implementation. This creates confusion about the actual changes being made.

Likely an incorrect or invalid review comment.


43-102: Excellent dual-theme syntax highlighting implementation.

The syntax highlighting implementation effectively handles both light and dark themes with proper theme switching using Tailwind classes. The token mapping and styling are well-structured.


105-121: Well-defined TypeScript interfaces.

The ChangelogFrontmatter and ChangelogEntry interfaces are properly structured with appropriate typing and good inheritance pattern.


124-190: Comprehensive markdown styling configuration.

The getMarkdownOptions function provides thorough styling for all markdown elements with consistent Tailwind CSS classes and proper integration of the custom syntax highlighting component.

Comment thread apps/ui/src/lib/utils/markdown.tsx
@smakosh
smakosh enabled auto-merge August 7, 2025 19:58
@smakosh
smakosh added this pull request to the merge queue Aug 7, 2025
Merged via the queue into main with commit 4579d42 Aug 7, 2025
9 checks passed
@smakosh
smakosh deleted the feat/ai-sdk-2-changelog-release branch August 7, 2025 20:02
@coderabbitai coderabbitai Bot mentioned this pull request Jan 4, 2026
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