Add GitHub Models integration

[sebastienros]

Description

Adds a new hosting integration for GitHub Models.

Fixes #9569 #7649

Checklist

• Is this feature complete?
  • Yes. Ready to ship.
  • No. Follow-up changes expected.
• Are you including unit tests for the changes and scenario tests if relevant?
  • Yes
  • No
• Did you add public API?
  • Yes
    • If yes, did you have an API Review for it?
      • Yes
      • No
    • Did you add <remarks /> and <code /> elements on your triple slash comments?
      • Yes
      • No
  • No
• Does the change make any security assumptions or guarantees?
  • Yes
    • If yes, have you done a threat model and had a security review?
      • Yes
      • No
  • No
• Does the change require an update in our Aspire docs?
  • Yes
    • [New article]: GitHub Models integration docs-aspire#3913
  • No

[Copilot]

Pull Request Overview

This PR introduces a new hosting integration for GitHub Models by providing a resource type, builder extensions, tests, documentation, and solution updates.

• Added GitHubModelsResource and connection‐string support
• Provided extension methods AddGitHubModel, WithEndpoint, and WithApiKey
• Included unit tests, README docs, and solution/project registrations

Reviewed Changes

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

Show a summary per file

File	Description
src/Aspire.Hosting.GitHub.Models/GitHubModelsResource.cs	Defines the GitHubModelsResource class with connection string
src/Aspire.Hosting.GitHub.Models/GitHubModelsExtensions.cs	Adds extension methods on IDistributedApplicationBuilder
tests/Aspire.Hosting.GitHub.Models.Tests/GitHubModelsExtensionTests.cs	Adds unit tests for the new extension methods
src/Aspire.Hosting.GitHub.Models/README.md	Documents installation and usage examples
Aspire.slnx	Registers new projects and playground folders

Comments suppressed due to low confidence (2)

src/Aspire.Hosting.GitHub.Models/GitHubModelsExtensions.cs:21

• Public API methods lack <remarks> and <code> examples in their XML comments. Please add <remarks> to explain scenarios and <code> snippets showing typical usage.

    public static IResourceBuilder<GitHubModelsResource> AddGitHubModel(this IDistributedApplicationBuilder builder, [ResourceName] string name, string model)

tests/Aspire.Hosting.GitHub.Models.Tests/GitHubModelsExtensionTests.cs:28

• Consider adding tests to verify the argument guards for AddGitHubModel, WithEndpoint, and WithApiKey, ensuring they throw the appropriate exceptions on null or empty inputs.

        var customEndpoint = "https://custom.endpoint.com";

[mitchdenny]

Great to see this finally coming in. Probably one of the easiest ways to get started with an LLM in Aspire.

I've got a few suggestions for improvements.

The first is that we should consider scanning the environment for the GITHUB_TOKEN. If you are running in a Codespaces and GitHub Actions (I think) this variable is available.

We might want to consider using the new dashboard message bar APIs to prompt for consent before using that token since there is usage fees attached. Alternatively have an extension like WithCodespaceToken or something like that.

[aaronpowell]

I agree with @mitchdenny on it using the GITHUB_TOKEN environment variable convention.

[sebastienros]

Couldn't find a way to create a health check that would take the key into account. There is no documented endpoint that doesn't consume tokens.

I also want to try embedding models and add support if possible.

[davidfowl]

@DamianEdwards tku made the external resource “running” yes? Parameters are now “active”, do we just. Make everything running ?

[GMouaad]

Can't wait to try this one out!!

[DamianEdwards]

@DamianEdwards tku made the external resource “running” yes? Parameters are now “active”, do we just. Make everything running ?

Yes I made the ExternalServiceResource "Running" because that's required to make it support health checks currently. I think it's fine to have a different status for things that really don't have a lifecycle (like parameters) but there's at all a lifecycle associated with what's being modeled and/or a benefit to it having a health check, we should likely keep it "Running".

[sebastienros]

Yes I made the ExternalServiceResource "Running" because that's required to make it support health checks

That's also something that bugged me.

[davidfowl]

@sebastienros can you share a video of the end to end?

[DamianEdwards]

new UriBuilder(builder["Endpoint"]) { Path = "/chat/completions" }.Build()?

[sebastienros]

With more !.ToString()!, it becomes quite ugly to read. Do you care much?

[eerhardt]

/backport to release/9.4

[github-actions]

Started backporting to release/9.4: https://github.com/dotnet/aspire/actions/runs/16205012651

[github-actions]

@eerhardt backporting to "release/9.4" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Add GitHub Models integration
.git/rebase-apply/patch:262: trailing whitespace.
    
.git/rebase-apply/patch:764: trailing whitespace.
        
.git/rebase-apply/patch:766: trailing whitespace.
        
.git/rebase-apply/patch:776: trailing whitespace.
        
.git/rebase-apply/patch:780: trailing whitespace.
        
warning: squelched 7 whitespace errors
warning: 12 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	Aspire.slnx
Falling back to patching base and 3-way merge...
Auto-merging Aspire.slnx
CONFLICT (content): Merge conflict in Aspire.slnx
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Add GitHub Models integration
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!