Skip to content

[docs] Add deprecation notices to GitHub Models integration docs#1279

Merged
IEvangelist merged 4 commits into
release/13.5from
docs/sunset-github-models-18405-81d5cd47296d3325
Jun 25, 2026
Merged

[docs] Add deprecation notices to GitHub Models integration docs#1279
IEvangelist merged 4 commits into
release/13.5from
docs/sunset-github-models-18405-81d5cd47296d3325

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#18405@sebastienros

Why this PR is needed

The GitHub Models service is no longer available to new customers (see microsoft/aspire#18402). In microsoft/aspire#18405, the Aspire.Hosting.GitHub.Models hosting integration was soft-sunsetted: all public APIs (AddGitHubModel, WithApiKey, WithHealthCheck, GitHubModelResource, GitHubModel) were marked [Obsolete], the package was hidden from aspire add, and its daily model-refresh automation was removed.

Users browsing the existing GitHub Models documentation pages have no indication that the service and integration are no longer viable for new projects. This PR adds a prominently placed :::caution callout to each of the three GitHub Models docs pages.

Target branch

Targeting release/13.5 based on the source PR milestone 13.5 (exact match on microsoft/aspire.dev).

Changes made

A :::caution[Integration deprecated] callout was added to the top of each page explaining:

  • The GitHub Models service is no longer available to new customers.
  • The integration is sunset as of .NET Aspire 13.5.
  • All public APIs are marked [Obsolete].
  • The package no longer appears in aspire add output.
  • One final obsolete NuGet release will be published; full removal follows in a later version.
  • Links to Sunset Github Models integration aspire#18402 for details.

Files modified

  • src/frontend/src/content/docs/integrations/ai/github-models/github-models-get-started.mdx — updated
  • src/frontend/src/content/docs/integrations/ai/github-models/github-models-host.mdx — updated
  • src/frontend/src/content/docs/integrations/ai/github-models/github-models-connect.mdx — updated

Generated by PR Documentation Check for issue #18405 · 1.1K AIC · ⌖ 21.2 AIC · ⊞ 45.7K ·

The GitHub Models service is no longer available to new customers.
Aspire.Hosting.GitHub.Models is sunset in 13.5 — all public APIs are
marked [Obsolete] and the package is hidden from aspire add. Add a
:::caution callout to all three GitHub Models documentation pages to
surface this to existing users.

Documents changes from microsoft/aspire#18405.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Jun 22, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from davidfowl June 22, 2026 21:05
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1279. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1279 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@sebastienros

Copy link
Copy Markdown
Contributor

Targeting correct branch and content is fine.

sebastienros and others added 2 commits June 22, 2026 16:20
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ment

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@sebastienros sebastienros marked this pull request as ready for review June 23, 2026 17:56
Copilot AI review requested due to automatic review settings June 23, 2026 17:56

Copilot AI 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.

Pull request overview

Adds prominent documentation notices to warn users that the GitHub Models service/integration is deprecated, aligning the docs with the upstream hosting integration soft-sunset in Aspire 13.5.

Changes:

  • Adds an :::caution[Integration deprecated] callout at the top of each GitHub Models integration page (get started / host / connect).
  • Updates the Aspire 13.5 “Breaking changes” section to include the GitHub Models deprecation, and expands the “Review deprecated APIs” caution accordingly.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/frontend/src/content/docs/whats-new/aspire-13-5.mdx Documents the GitHub Models deprecation in the Aspire 13.5 breaking changes and deprecation review callout.
src/frontend/src/content/docs/integrations/ai/github-models/github-models-host.mdx Adds a top-of-page caution callout warning the integration is deprecated and pointing to Azure AI Foundry.
src/frontend/src/content/docs/integrations/ai/github-models/github-models-get-started.mdx Adds a top-of-page caution callout warning the integration is deprecated and pointing to Azure AI Foundry.
src/frontend/src/content/docs/integrations/ai/github-models/github-models-connect.mdx Adds a top-of-page caution callout warning the integration is deprecated and pointing to Azure AI Foundry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


3. **aspire ps --resources flag removed**: The `--resources` and `--include-hidden` flags have been removed from `aspire ps`, which now focuses on AppHost-level summaries. Use `aspire describe` for detailed resource data.

4. **GitHub Models integration deprecated**: The GitHub Models service is no longer available to new customers, so the `Aspire.Hosting.GitHub.Models` integration is sunset as of Aspire 13.5. All public APIs are marked `[Obsolete]`, and the package no longer appears in `aspire add` output. One final obsolete release will ship on NuGet, and the package will be removed entirely in a future version. Migrate to the [Azure AI Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/) instead. See [microsoft/aspire#18402](https://github.com/microsoft/aspire/issues/18402) for details.
Co-authored-by: David Pine <david.pine@microsoft.com>
@IEvangelist IEvangelist enabled auto-merge (squash) June 25, 2026 18:54
@IEvangelist IEvangelist merged commit 2550c15 into release/13.5 Jun 25, 2026
9 checks passed
@IEvangelist IEvangelist deleted the docs/sunset-github-models-18405-81d5cd47296d3325 branch June 25, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants