Pre-release 0.41.135

Author: actions-user

BYOK.md

@@ -0,0 +1,40 @@
+# Adding your API Keys with GitHub Copilot -  Bring Your Own Key(BYOK)
+
+
+Copilot for Xcode supports **Bring Your Own Key (BYOK)** integration with multiple model providers. You can bring your own API keys to integrate with your preferred model provider, giving you full control and flexibility.
+
+Supported providers include:
+- Anthropic
+- Azure
+- Gemini
+- Groq
+- OpenAI
+- OpenRouter
+
+
+## Configuration Steps
+
+
+To configure BYOK in Copilot for Xcode:
+
+- Open the Copilot chat and select “Manage Models” from the Model picker.
+- Choose your preferred AI provider (e.g., Anthropic, OpenAI, and Azure).
+- Enter the required provider-specific details, such as the API key and endpoint URL (if applicable).
+
+
+| Model Provider    | How to get the API Keys                                                                                     |
+|-------------------|------------------------------------------------------------------------------------------------------------|
+| Anthropic         | Sign in to the [Anthropic Console](https://console.anthropic.com/dashboard) to generate and retrieve your API key.  |
+| Gemini (Google)   | Sign in to the [Google Cloud Console](https://aistudio.google.com/app/apikey) to generate and retrieve your API key.                             |
+| Groq              | Sign in to the [Groq Console](https://console.groq.com/keys) to generate and retrieve your API key.        |
+| OpenAI            | Sign in to the [OpenAI’s Platform](https://platform.openai.com/api-keys) to generate and retrieve your API key.    |
+| OpenRouter        | Sign in to the [OpenRouter’s API Key Settings](https://openrouter.ai/settings/keys) to generate your API key. |
+| Azure             | Sign in to the [Azure AI Foundry](https://ai.azure.com/), go to your [Deployments](https://ai.azure.com/resource/deployments/), and retrieve your API key and Endpoint after the deployment is complete. Ensure the model name you enter matches the one you deployed, as shown on the Details page.|
+
+
+- Click "Add" button to continue.
+- Once saved, it will list available AI models in the Models setting page. You can enable the models you intend to use with GitHub Copilot.
+
+> [!NOTE]
+> Please keep your API key confidential and never share it publicly for safety.
+  

Copilot for Xcode/App.swift

@@ -21,6 +21,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         case chat
         case settings
         case mcp
+        case byok
     }
 
     func applicationDidFinishLaunching(_ notification: Notification) {
@@ -50,6 +51,8 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             return .settings
         } else if launchArgs.contains("--mcp") {
             return .mcp
+        } else if launchArgs.contains("--byok") {
+            return .byok
         } else {
             return .chat
         }
@@ -61,6 +64,8 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             openSettings()
         case .mcp:
             openMCPSettings()
+        case .byok:
+            openBYOKSettings()
         case .chat:
             openChat()
         }
@@ -84,7 +89,14 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     private func openMCPSettings() {
         DispatchQueue.main.async {
             activateAndOpenSettings()
-            hostAppStore.send(.setActiveTab(2))
+            hostAppStore.send(.setActiveTab(.mcp))
+        }
+    }
+    
+    private func openBYOKSettings() {
+        DispatchQueue.main.async {
+            activateAndOpenSettings()
+            hostAppStore.send(.setActiveTab(.byok))
         }
     }
 
@@ -187,7 +199,18 @@ struct CopilotForXcodeApp: App {
         ) { _ in
             DispatchQueue.main.async {
                 activateAndOpenSettings()
-                hostAppStore.send(.setActiveTab(2))
+                hostAppStore.send(.setActiveTab(.mcp))
+            }
+        }
+        
+        DistributedNotificationCenter.default().addObserver(
+            forName: .openBYOKSettingsWindowRequest,
+            object: nil,
+            queue: .main
+        ) { _ in
+            DispatchQueue.main.async {
+                activateAndOpenSettings()
+                hostAppStore.send(.setActiveTab(.byok))
             }
         }
     }

Copilot for Xcode/Assets.xcassets/QuaternarySystemFillColor.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0xF7",
+          "green" : "0xF7",
+          "red" : "0xF7"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0x09",
+          "green" : "0x09",
+          "red" : "0x09"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Copilot for Xcode/Assets.xcassets/QuinarySystemFillColor.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0xFB",
+          "green" : "0xFB",
+          "red" : "0xFB"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0x07",
+          "green" : "0x07",
+          "red" : "0x07"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Copilot for Xcode/Assets.xcassets/SecondarySystemFillColor.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0xE6",
+          "green" : "0xE6",
+          "red" : "0xE6"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0x14",
+          "green" : "0x14",
+          "red" : "0x14"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Copilot for Xcode/Assets.xcassets/TertiarySystemFillColor.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0xF2",
+          "green" : "0xF2",
+          "red" : "0xF2"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0x0D",
+          "green" : "0x0D",
+          "red" : "0x0D"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Core/Sources/ChatService/ChatService.swift

@@ -21,7 +21,19 @@ import SuggestionBasic
 
 public protocol ChatServiceType {
     var memory: ContextAwareAutoManagedChatMemory { get set }
-    func send(_ id: String, content: String, contentImages: [ChatCompletionContentPartImage], contentImageReferences: [ImageReference], skillSet: [ConversationSkill], references: [FileReference], model: String?, agentMode: Bool, userLanguage: String?, turnId: String?) async throws
+    func send(
+        _ id: String,
+        content: String,
+        contentImages: [ChatCompletionContentPartImage],
+        contentImageReferences: [ImageReference],
+        skillSet: [ConversationSkill],
+        references: [ConversationAttachedReference],
+        model: String?,
+        modelProviderName: String?,
+        agentMode: Bool,
+        userLanguage: String?,
+        turnId: String?
+    ) async throws
     func stopReceivingMessage() async
     func upvote(_ id: String, _ rating: ConversationRating) async
     func downvote(_ id: String, _ rating: ConversationRating) async
@@ -333,8 +345,9 @@ public final class ChatService: ChatServiceType, ObservableObject {
         contentImages: Array<ChatCompletionContentPartImage> = [],
         contentImageReferences: Array<ImageReference> = [],
         skillSet: Array<ConversationSkill>,
-        references: Array<FileReference>,
+        references: [ConversationAttachedReference],
         model: String? = nil,
+        modelProviderName: String? = nil,
         agentMode: Bool = false,
         userLanguage: String? = nil,
         turnId: String? = nil
@@ -439,6 +452,7 @@ public final class ChatService: ChatServiceType, ObservableObject {
             activeDoc: activeDoc,
             references: references,
             model: model,
+            modelProviderName: modelProviderName,
             agentMode: agentMode,
             userLanguage: userLanguage,
             turnId: currentTurnId,
@@ -455,8 +469,9 @@ public final class ChatService: ChatServiceType, ObservableObject {
         content: String,
         contentImages: [ChatCompletionContentPartImage] = [],
         activeDoc: Doc?,
-        references: [FileReference],
+        references: [ConversationAttachedReference],
         model: String? = nil,
+        modelProviderName: String? = nil,
         agentMode: Bool = false,
         userLanguage: String? = nil,
         turnId: String? = nil,
@@ -481,6 +496,7 @@ public final class ChatService: ChatServiceType, ObservableObject {
             ignoredSkills: ignoredSkills,
             references: references,
             model: model,
+            modelProviderName: modelProviderName,
             agentMode: agentMode,
             userLanguage: userLanguage,
             turnId: turnId
@@ -527,7 +543,7 @@ public final class ChatService: ChatServiceType, ObservableObject {
         deleteChatMessageFromStorage(id)
     }
 
-    public func resendMessage(id: String, model: String? = nil) async throws {
+    public func resendMessage(id: String, model: String? = nil, modelProviderName: String? = nil) async throws {
         if let _ = (await memory.history).first(where: { $0.id == id }),
            let lastUserRequest
         {
@@ -540,6 +556,7 @@ public final class ChatService: ChatServiceType, ObservableObject {
                 skillSet: skillSet,
                 references: lastUserRequest.references ?? [],
                 model: model != nil ? model : lastUserRequest.model,
+                modelProviderName: modelProviderName != nil ? modelProviderName : lastUserRequest.modelProviderName,
                 agentMode: lastUserRequest.agentMode,
                 userLanguage: lastUserRequest.userLanguage,
                 turnId: id
@@ -1050,21 +1067,35 @@ func replaceFirstWord(in content: String, from oldWord: String, to newWord: Stri
     return content
 }
 
-extension Array where Element == Reference {
+extension Array where Element == FileReference {
     func toConversationReferences() -> [ConversationReference] {
         return self.map {
-            .init(uri: $0.uri, status: .included, kind: .reference($0))
+            .init(uri: $0.uri, status: .included, kind: .reference($0), referenceType: .file)
         }
     }
 }
 
-extension Array where Element == FileReference {
+extension Array where Element == ConversationAttachedReference {
     func toConversationReferences() -> [ConversationReference] {
         return self.map {
-            .init(uri: $0.url.path, status: .included, kind: .fileReference($0))
+            switch $0 {
+            case .file(let fileRef): 
+                    .init(
+                        uri: fileRef.url.path,
+                        status: .included,
+                        kind: .fileReference($0),
+                        referenceType: .file)
+            case .directory(let directoryRef): 
+                    .init(
+                        uri: directoryRef.url.path,
+                        status: .included,
+                        kind: .fileReference($0),
+                        referenceType: .directory)
+            }
         }
     }
 }
+
 extension [ChatMessage] {
     // transfer chat messages to turns
     // used to restore chat history for CLS