Skip to content

Document GitHub Models retirement #1606

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
David Pine (IEvangelist) merged 3 commits into from
Sep 10, 2026
+32 −145
Merged

Document GitHub Models retirement #1606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d7e0c4
Document GitHub Models retirement
eerhardt Sep 1, 2026
6d38c59
Address GitHub Models docs feedback
eerhardt Sep 1, 2026
1c0bb13
Apply batched suggestions from code review
IEvangelist Sep 10, 2026
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: 3 additions & 3 deletions ...ontend/src/content/docs/integrations/ai/github-models/github-models-connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import githubIcon from '@assets/icons/github-icon.png';
data-zoom-off
/>

:::caution[Integration deprecated]
The GitHub Models service is **no longer available to new customers**. 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. The package will ship one final obsolete release on NuGet and will be removed entirely in a future version. For new and existing apps, use the [Azure AI Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/) instead, which provides access to a broad catalog of models — including OpenAI's GPT models — and supports local development with `RunAsFoundryLocal()`. See [microsoft/aspire#18402](https://github.com/microsoft/aspire/issues/18402) for details.
:::caution[GitHub Models retired]
[GitHub Models was retired for all customers on July 30, 2026](https://github.blog/changelog/2026-07-30-github-models-is-now-retired/). The `Aspire.Hosting.GitHub.Models` integration is discontinued. Its final release shipped with Aspire 13.5, and the integration will be removed after that release. Migrate new and existing apps to the [Microsoft Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/). The rest of this article is retained as a historical reference. For more information about the retired service, see the [GitHub Models documentation](https://docs.github.com/github-models).
:::

This page describes how consuming apps connect to a GitHub Model resource that's already modeled in your AppHost. For the AppHost API surface — adding a model resource, API key parameters, organization configuration, and health checks — see [GitHub Models hosting integration](../github-models-host/).
Expand Down Expand Up @@ -361,7 +361,7 @@ console.log(response.choices[0].message.content);

## See also

- [Get started with the GitHub Models integrations](/integrations/ai/github-models/github-models-get-started/)
- [Migrate Aspire apps from GitHub Models](/integrations/ai/github-models/github-models-get-started/)
- [GitHub Models hosting integration](/integrations/ai/github-models/github-models-host/)
- [GitHub Models Marketplace](https://github.com/marketplace/models)
- [GitHub Models documentation](https://docs.github.com/github-models)
82 changes: 19 additions & 63 deletions ...nd/src/content/docs/integrations/ai/github-models/github-models-get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Get started with the GitHub Models integrations
description: Learn how the Aspire GitHub Models integrations register a GitHub Models resource and wire the .NET client to call models hosted on GitHub.
title: Migrate Aspire apps from GitHub Models
description: Learn how to migrate Aspire apps from the discontinued GitHub Models integration to Microsoft Foundry for continued AI model access.
prev: false
---

import { Image } from 'astro:assets';
import { LinkButton, Steps } from '@astrojs/starlight/components';
import { Steps } from '@astrojs/starlight/components';
import githubIcon from '@assets/icons/github-icon.png';
Comment thread
IEvangelist marked this conversation as resolved.

<Image
Expand All @@ -17,78 +17,34 @@ import githubIcon from '@assets/icons/github-icon.png';
data-zoom-off
/>

:::caution[Integration deprecated]
The GitHub Models service is **no longer available to new customers**. 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. The package will ship one final obsolete release on NuGet and will be removed entirely in a future version. For new and existing apps, use the [Azure AI Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/) instead, which provides access to a broad catalog of models — including OpenAI's GPT models — and supports local development with `RunAsFoundryLocal()`. See [microsoft/aspire#18402](https://github.com/microsoft/aspire/issues/18402) for details.
:::caution[GitHub Models retired]
[GitHub Models was retired for all customers on July 30, 2026](https://github.blog/changelog/2026-07-30-github-models-is-now-retired/). The `Aspire.Hosting.GitHub.Models` integration is discontinued. Its final release shipped with Aspire 13.5, and the integration will be removed after that release. Migrate new and existing apps to the [Microsoft Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/). For more information about the retired service, see the [GitHub Models documentation](https://docs.github.com/github-models).
:::

[GitHub Models](https://github.com/marketplace/models) provides access to a broad catalog of AI models — including OpenAI's GPT models, DeepSeek, Microsoft's Phi models, and more — through GitHub's infrastructure and your existing GitHub token. The Aspire GitHub Models integration lets you model a GitHub Model resource as a first-class resource in your AppHost, then hand the connection information to any consuming app — regardless of language.
The GitHub Models playground, model catalog, inference API, and bring your own key (BYOK) capabilities are no longer available. Existing apps that use the Aspire GitHub Models integration can't send inference requests to the retired service.

## Why use GitHub Models with Aspire
## Migrate to Microsoft Foundry

Adding GitHub Models through Aspire — rather than hard-coding API keys and endpoints in each service — gives you:

- **Centralized credential management.** The GitHub token is stored once as a secret parameter in the AppHost and injected into each consuming app automatically.
- **Typed model resources with connection strings.** Each GitHub Model resource composes a connection string from the endpoint, API key, and model identifier, giving consuming apps a single named connection.
- **Consistent connection info across languages.** Once you reference a model resource from a consuming app, Aspire injects connection properties as environment variables in a predictable format that works from C#, TypeScript, Python, Go, or any other language.
- **Automatic `GITHUB_TOKEN` fallback.** In Codespaces and GitHub Actions the ambient `GITHUB_TOKEN` is used automatically — no extra secrets to configure.
- **A first-class C# client integration.** C# apps can use `Aspire.Azure.AI.Inference` or `Aspire.OpenAI` for dependency injection, health checks, and OpenTelemetry, all wired up from the same resource name.

## How the pieces fit together

The GitHub Models integration has two sides: a **hosting integration** that you use in your AppHost to model the GitHub Model resource, and a **connection story** for consuming apps that reference it.

```mermaid
architecture-beta

group apphost(server)[AppHost]
group consumer(server)[Consuming app]

service hosting(server)[Hosting integration] in apphost
service githubmodels(internet)[GitHub Models API] in apphost
service model(database)[chat model] in apphost

service client(iconoir:server-connection)[Client integration] in consumer
service app(server)[App] in consumer

hosting:R --> L:githubmodels
githubmodels:R --> L:model
model:R --> L:client
client:R --> L:app
```

The **hosting integration** lives in your AppHost project and models the GitHub Model resource. The **client integration** lives in each consuming app and uses the connection information Aspire injects to call the GitHub Models API.

Getting there is a two-step process: model the GitHub Model resource in your AppHost, then connect to the API from each app that needs it.
Microsoft Foundry provides a broad model catalog and supports both cloud-hosted deployments and local development. To migrate:

<Steps>

1. ### Model GitHub Models in your AppHost

Add the GitHub Models hosting integration to your AppHost, then declare a model resource and reference it from the apps that need to call the API. The [GitHub Models hosting integration](/integrations/ai/github-models/github-models-host/) article walks through every capability — adding model resources, API key parameters, organization configuration, and health checks — with side-by-side C# and TypeScript examples.
1. Remove the `Aspire.Hosting.GitHub.Models` package from your AppHost and remove GitHub Models resources, API key parameters, and `GITHUB_TOKEN` configuration.
2. Follow the [Microsoft Foundry hosting integration guide](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-host/) to add a Foundry resource and model deployment. For local development, you can configure the resource to run with Foundry Local.
3. Reference the Foundry deployment from each consuming app that needs model access.
4. Follow [Connect to Microsoft Foundry](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-connect/) to update client configuration and environment-variable handling. Don't reuse retired GitHub Models endpoints, tokens, or model identifiers.

<LinkButton
variant='secondary'
iconPlacement='end'
icon='right-arrow'
href='/integrations/ai/github-models/github-models-host/'>
Set up GitHub Models in the AppHost
</LinkButton>

2. ### Connect from your consuming app
</Steps>

When you reference a GitHub Model resource from a consuming app, Aspire injects its connection information as environment variables. See [Connect to GitHub Models](/integrations/ai/github-models/github-models-connect/) for the connection properties reference and per-language examples for C#, Go, Python, and TypeScript — including the full C# client integration.
## Aspire 13.5 historical reference

<LinkButton
variant='secondary'
iconPlacement='end'
icon='right-arrow'
href='/integrations/ai/github-models/github-models-connect/'>
Connect to GitHub Models
</LinkButton>
The following articles document the final Aspire 13.5 integration surface for migration and historical reference. Their examples don't restore access to the retired GitHub Models service:

</Steps>
- [GitHub Models hosting integration](/integrations/ai/github-models/github-models-host/)
- [Connect to GitHub Models](/integrations/ai/github-models/github-models-connect/)

## See also

- [GitHub Models on GitHub Marketplace](https://github.com/marketplace/models)
- [Microsoft Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/)
- [GitHub Models retirement notice](https://github.blog/changelog/2026-07-30-github-models-is-now-retired/)
- [GitHub Models documentation](https://docs.github.com/github-models)
39 changes: 9 additions & 30 deletions src/frontend/src/content/docs/integrations/ai/github-models/github-models-host.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: Learn how to use the Aspire GitHub Models hosting integration to or

import { Image } from 'astro:assets';
import { Aside, Steps, Tabs, TabItem } from '@astrojs/starlight/components';
import LearnMore from '@components/LearnMore.astro';
import githubIcon from '@assets/icons/github-icon.png';

<Image
Expand All @@ -17,56 +16,36 @@ import githubIcon from '@assets/icons/github-icon.png';
data-zoom-off
/>

:::caution[Integration deprecated]
The GitHub Models service is **no longer available to new customers**. 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. The package will ship one final obsolete release on NuGet and will be removed entirely in a future version. For new and existing apps, use the [Azure AI Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/) instead, which provides access to a broad catalog of models — including OpenAI's GPT models — and supports local development with `RunAsFoundryLocal()`. See [microsoft/aspire#18402](https://github.com/microsoft/aspire/issues/18402) for details.
:::caution[GitHub Models retired]
[GitHub Models was retired for all customers on July 30, 2026](https://github.blog/changelog/2026-07-30-github-models-is-now-retired/). The `Aspire.Hosting.GitHub.Models` integration is discontinued. Its final release shipped with Aspire 13.5, and the integration will be removed after that release. Migrate new and existing apps to the [Microsoft Foundry integration](/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started/). The rest of this article is retained as a historical reference. For more information about the retired service, see the [GitHub Models documentation](https://docs.github.com/github-models).
:::

This article is the reference for the Aspire GitHub Models hosting integration. It enumerates the AppHost APIs — with examples for both `AppHost.cs` and `apphost.mts` — that you use to model GitHub Model resources in your [`AppHost`](/get-started/app-host/) project.

If you're new to the GitHub Models integration, start with the [Get started with GitHub Models integrations](/integrations/ai/github-models/github-models-get-started/) guide. For how consuming apps read the connection information this page exposes, see [Connect to GitHub Models](../github-models-connect/).
For migration guidance, see [Migrate Aspire apps from GitHub Models](/integrations/ai/github-models/github-models-get-started/). For how consuming apps read the connection information this page exposes, see [Connect to GitHub Models](../github-models-connect/).

## Installation

To start building an Aspire app that uses GitHub Models, install the [📦 Aspire.Hosting.GitHub.Models](https://www.nuget.org/packages/Aspire.Hosting.GitHub.Models) NuGet package:
The following examples pin the final [📦 Aspire.Hosting.GitHub.Models 13.5.1](https://www.nuget.org/packages/Aspire.Hosting.GitHub.Models/13.5.1) package for historical reference. The package is hidden from `aspire add` because the integration is discontinued.

@mitchdenny Mitch Denny (mitchdenny) Sep 2, 2026

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.

The live NuGet feed lists 13.5.2 and 13.5.3, so 13.5.1 is not the final Aspire.Hosting.GitHub.Models package. Please either pin 13.5.3 throughout these historical examples or remove “the final” and explain why 13.5.1 is intentionally used. The fixed historical pin itself is appropriate and does not need a current-version placeholder.

@IEvangelist David Pine (IEvangelist) Sep 2, 2026

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.

Package version mismatch: The linked NuGet Versions tab lists 13.5.3 and 13.5.2 after 13.5.1, so calling 13.5.1 the final package and pinning it in all historical examples is incorrect. The fallback source ref microsoft/aspire@main (737af0f) cannot support that finality claim either: it is versioned 13.6-preview and still includes the packable GitHub Models project (eng/Versions.props:3-8, src/Aspire.Hosting.GitHub.Models/Aspire.Hosting.GitHub.Models.csproj:3-9, eng/Build.props:47-54). Please pin the actual final version (the live feed currently shows 13.5.3) throughout, or remove "final" and explain why 13.5.1 is intentional.


<Tabs syncKey="aspire-lang">
<TabItem id="csharp" label="C#">

```bash title="Terminal"
aspire add github-models
```

<LearnMore>
Learn more about [`aspire add`](/reference/cli/commands/aspire-add/) in the command reference.
</LearnMore>

Or, choose a manual installation approach:

```csharp title="AppHost.cs"
#:package Aspire.Hosting.GitHub.Models@*
#:package Aspire.Hosting.GitHub.Models@13.5.1
```

```xml title="AppHost.csproj"
<PackageReference Include="Aspire.Hosting.GitHub.Models" Version="*" />
<PackageReference Include="Aspire.Hosting.GitHub.Models" Version="13.5.1" />
```

</TabItem>
<TabItem id="typescript" label="TypeScript">

```bash title="Terminal"
aspire add github-models
```

<LearnMore>
Learn more about [`aspire add`](/reference/cli/commands/aspire-add/) in the command reference.
</LearnMore>

This updates your `aspire.config.json` with the GitHub Models hosting integration package:

```json title="aspire.config.json" ins={3}
```json title="aspire.config.json"
{
"packages": {
"Aspire.Hosting.GitHub.Models": "%ASPIRE_VERSION%"
"Aspire.Hosting.GitHub.Models": "13.5.1"
}
}
```
Expand Down Expand Up @@ -325,7 +304,7 @@ For the full reference of GitHub Models connection properties — and how consum

## See also

- [Get started with the GitHub Models integrations](/integrations/ai/github-models/github-models-get-started/)
- [Migrate Aspire apps from GitHub Models](/integrations/ai/github-models/github-models-get-started/)
- [Connect to GitHub Models](/integrations/ai/github-models/github-models-connect/)
- [GitHub Models Marketplace](https://github.com/marketplace/models)
- [GitHub Models documentation](https://docs.github.com/github-models)
50 changes: 1 addition & 49 deletions src/frontend/src/content/docs/integrations/cloud/azure/ai-compatibility-matrix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ The following table shows the compatibility between Aspire AI hosting and client
| `Aspire.Hosting.Foundry` | ❌ No | ⚠️ Partial | ✅ Yes (preferred) |
| `Aspire.Hosting.Azure.CognitiveServices` | ❌ No | ✅ Yes (preferred) | ❌ No |
| `Aspire.Hosting.OpenAI` | ✅ Yes (preferred) | ✅ Yes | ❌ No |
| `Aspire.Hosting.GitHub.Models` | ⚠️ Partial | ❌ No | ✅ Yes (preferred) |

<Aside type="note" title="Legend">

Expand Down Expand Up @@ -165,47 +164,6 @@ The [Aspire.OpenAI](https://www.nuget.org/packages/Aspire.OpenAI) package provid
builder.AddOpenAIClient("openai");
```

### GitHub Models

For GitHub Models, use the **Aspire.Azure.AI.Inference** client integration for the best compatibility with the GitHub Models API. For more information, see [Aspire GitHub Models integration (Preview)](/integrations/ai/github-models/github-models-get-started/).

#### Hosting integration

The [Aspire.Hosting.GitHub.Models](https://www.nuget.org/packages/Aspire.Hosting.GitHub.Models) package provides the hosting integration. In your app host project:

<Tabs syncKey="aspire-lang">
<TabItem id="csharp" label="C#">
```csharp title="AppHost.cs"
var builder = DistributedApplication.CreateBuilder(args);

var chat = builder.AddGitHubModel("chat", "openai/gpt-4o-mini");

builder.AddProject<Projects.ExampleProject>()
.WithReference(chat);
```
</TabItem>
<TabItem id="typescript" label="TypeScript">
```typescript title="apphost.mts" twoslash
import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const chat = await builder.addGitHubModelById("chat", "openai/gpt-4o-mini");

await builder.addNodeApp("api", "./api", "index.js")
.withReference(chat);
```
</TabItem>
</Tabs>

#### Client integration

The [Aspire.Azure.AI.Inference](https://www.nuget.org/packages/Aspire.Azure.AI.Inference) package provides the client integration. In your service project:

```csharp title="Program.cs"
builder.AddAzureChatCompletionsClient("chat");
```

## Connection string formats

Understanding how hosting and client integrations communicate through connection strings can help you troubleshoot connectivity issues and understand the underlying mechanics.
Expand Down Expand Up @@ -248,12 +206,6 @@ Endpoint={EmulatorServiceUri};Key={ApiKey}
Endpoint={Endpoint};Key={Key};Model={Model}
```

#### Aspire.Hosting.GitHub.Models

```
Endpoint=https://models.github.ai/inference;Key={Key};Model={ModelName}
```

### Client integration connection string requirements

#### Aspire.OpenAI
Expand Down Expand Up @@ -286,7 +238,7 @@ Expects connection strings in the format:
Endpoint={Endpoint};EndpointAIInference={EndpointAIInference};Key={Key};Deployment={DeploymentName};Model={ModelName}
```

Uses either `Deployment` or `Model` (in that order). `Deployment` is set by `Aspire.Hosting.Azure.CognitiveServices` while `Model` is set by `Aspire.Hosting.GitHub.Models`.
Uses either `Deployment` or `Model` (in that order).

Uses `EndpointAIInference` if available, otherwise `Endpoint`.

Expand Down
Loading