github / github/copilot-sdk

[v2] Consolidate runtime discovery, acquisition, and embedding

Ouverte
#2,524 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
sdk-v2
Langage dominant
Java
Étoiles
10.5k
Forks
1.5k
Merge moyen
1 j 11 h
PR mergées (30 j)
128

Description

## Summary

Complete a coherent model for locating, acquiring, packaging, and embedding the Copilot runtime across all SDKs.

These items are planned work carried forward from #1934. Existing work may satisfy part of the required outcome; verify and build on it rather than reopening completed implementation. Do not omit remaining work without concrete new evidence and maintainer agreement.

## Why this work exists

The original Rust `build.rs` was forked between in-process and out-of-process modes for backward compatibility. In-process operation needed the `.node` native binary, which was available from `@github/copilot` on npm but was not included in the GitHub CLI release. Depending on npm for that binary was not considered viable long term.

Rust and Go also used build-time flags to choose whether the in-process binary was embedded because it duplicated the Copilot SEA executable already embedded in the application bundle.

Python independently performed executable resolution through `PATH` (introduced by commit `05dd60e`), which could select an arbitrary system installation rather than the runtime expected by the SDK.

## Required outcomes

- Python does not implicitly select an executable through `PATH`; it uses the SDK-managed runtime or an explicitly configured path.
- The underlying runtime build and publishing process publishes the required raw native binaries as separate GitHub Release assets.
- SDKs acquire pinned, checksum-verified runtime artifacts from `github/copilot-cli` GitHub Releases rather than depending on `@github/copilot` npm artifacts.
- Obsolete Rust and Go compile-time choices for embedding the in-process native library versus the executable runtime are removed.
- Packaging converges on a minimal bootstrap executable plus the required native dynamic library without duplicating the full SEA/native runtime payload.
- All supported platforms, offline/development scenarios, explicit overrides, checksums, and cache replacement behavior are covered.

## Implementation preparation

- Determine exactly which outcomes #2395, #2463, and #2505 already satisfy.
- Complete rather than duplicate applicable in-progress work.
- Identify and link any missing release assets or changes required from `github/copilot-cli`.
- If a remaining change is compatible with v1, it may land there as groundwork while remaining part of this tracked outcome.
- Preserve backward compatibility where it does not conflict with the intended v2 cleanup, and document any runtime-version requirements.

## Historical context

- #1934
- Commit `05dd60e`
- #2395
- #2463
- #2505

## Completion

Deliver the required outcomes across affected SDKs with a documented artifact contract and platform coverage. Any outcome considered obsolete or infeasible requires concrete evidence and explicit maintainer agreement before it is removed from scope.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by reviewing #1934 and determining what #2395, #2463, and #2505 already cover, along with the referenced commit 05dd60e. Trace the runtime acquisition, packaging, and embedding paths across the affected SDKs and identify any required github/copilot-cli release assets. Done means the documented artifact contract and platform, offline, override, checksum, and cache behavior are implemented without duplicating completed work.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github, go, python, rust
Domaine
backend-api-design, build-system, devops, release
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.