Add multi-language Copilot SDK driver samples and wire daily workflows to exercise runtime installs by Copilot · Pull Request #36734 · github/gh-aw

Copilot · 2026-06-03T21:23:18Z

This PR adds minimal Copilot SDK driver samples for each supported script language and assigns them to daily Copilot SDK workflows. The goal is to ensure runtime-specific Copilot SDK installation paths are exercised continuously in real workflow runs.

Driver samples in repository
- Added .github/drivers/ with minimal script drivers for:
  - Node (.cjs)
  - Python (.py)
  - TypeScript (.ts)
  - Ruby (.rb)
- Each sample is a self-contained SDK program that creates a client, creates a session, runs prompts, and writes the assistant result to stdout (no delegation to copilot_sdk_driver.cjs).
- COPILOT_MODEL is a required environment variable in all sample drivers; each driver fails fast with a clear error when it is not set.
Daily workflow assignment
- Updated daily Copilot SDK workflows to use language-specific engine.copilot-sdk-driver values as full workspace-relative paths (e.g. .github/drivers/copilot_sdk_driver_sample_python.py) so each runtime path is covered by scheduled automation.
Copilot SDK execution path
- Removed implicit .github/drivers path prefix from the execution engine. The copilot-sdk-driver field value is now used directly as a workspace-relative path (${GITHUB_WORKSPACE}/<value>). Callers must always specify the full relative path from the workspace root.
Validation
- Updated validateEngineCopilotSDKDriver to allow /-separated relative paths with safe segments while rejecting absolute paths, .., backslashes, shell metacharacters, empty segments (consecutive //, trailing /), and unsupported extensions.
- Updated the JSON schema pattern for copilot-sdk-driver to match the new path format.
Runtime install mapping
- Updated TypeScript driver runtime detection/install path to provision ts-node + typescript alongside @github/copilot-sdk, so .ts/.mts drivers execute without extra manual setup.
Specification and docs
- Updated copilot-sdk-driver-specification.md to mark COPILOT_MODEL as a required standalone environment variable with a MUST constraint, and updated the non-normative TypeScript example accordingly.
- Updated engines.md reference docs to show full workspace-relative path examples and document COPILOT_MODEL as required.

engine:
  id: copilot
  copilot-sdk: true
  copilot-sdk-driver: .github/drivers/copilot_sdk_driver_sample_typescript.ts

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2026-06-03T21:33:07Z

@copilot the sample drivers should be self-contained programs that use the copilot SDK APIs in each language to create a client, create a session, run prompts, and output the result to the console. Do not spawn copilot_sdk_driver.cjs

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-06-03T21:50:32Z

@copilot the sample drivers should be self-contained programs that use the copilot SDK APIs in each language to create a client, create a session, run prompts, and output the result to the console. Do...

Addressed in c844585. The sample drivers are now self-contained SDK flows: Node/TypeScript/Python create a client, create a session, run the prompt from GH_AW_PROMPT, and print assistant output directly. The Ruby sample no longer delegates to copilot_sdk_driver.cjs and runs its own inline SDK flow.

pelikhan · 2026-06-03T21:54:34Z

@copilot

merge main, recompile
update specification and docs and sample drivers that COPILOT_MODEL is a REQUIRED environment variable

Copilot

Pull request overview

This PR adds minimal Copilot SDK driver samples in multiple scripting languages and updates daily Copilot SDK workflows so scheduled runs exercise runtime-specific installation and execution paths (including custom driver resolution from the repository workspace).

Changes:

Added .github/drivers/ sample SDK drivers (Node, TypeScript, Python, Ruby) and configured daily workflows to use them via engine.copilot-sdk-driver.
Updated Copilot engine execution to resolve custom SDK drivers from ${GITHUB_WORKSPACE}/.github/drivers instead of the setup-action directory.
Updated Copilot SDK install mapping so TypeScript drivers install ts-node + typescript alongside @github/copilot-sdk.

Show a summary per file

File	Description
pkg/workflow/copilot_engine_test.go	Updates tests for custom-driver resolution path and TypeScript install expectations.
pkg/workflow/copilot_engine_installation.go	Adds a TypeScript-specific SDK install spec and runtime detection for `ts-node`.
pkg/workflow/copilot_engine_execution.go	Resolves custom SDK drivers from workspace `.github/drivers` and adjusts command formatting.
.github/workflows/daily-workflow-updater.md	Sets the daily updater to use the Ruby sample SDK driver.
.github/workflows/daily-workflow-updater.lock.yml	Regenerated lockfile reflecting the Ruby driver wiring/execution.
.github/workflows/daily-skill-optimizer.md	Sets the daily skill optimizer to use the TypeScript sample SDK driver.
.github/workflows/daily-skill-optimizer.lock.yml	Regenerated lockfile reflecting the TypeScript driver install/execution.
.github/workflows/daily-model-inventory.md	Sets the daily model inventory workflow to use the Node sample SDK driver.
.github/workflows/daily-model-inventory.lock.yml	Regenerated lockfile reflecting the Node driver wiring/execution.
.github/workflows/daily-issues-report.md	Sets the daily issues report workflow to use the Python sample SDK driver.
.github/workflows/daily-issues-report.lock.yml	Regenerated lockfile reflecting the Python driver install/execution.
.github/drivers/copilot_sdk_driver_sample_typescript.ts	New TypeScript Copilot SDK driver sample.
.github/drivers/copilot_sdk_driver_sample_ruby.rb	New Ruby (Node-embedded) Copilot SDK driver sample.
.github/drivers/copilot_sdk_driver_sample_python.py	New Python Copilot SDK driver sample.
.github/drivers/copilot_sdk_driver_sample_node.cjs	New Node Copilot SDK driver sample.

Copilot's findings

Tip

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

Files reviewed: 15/15 changed files
Comments generated: 5

 			driverRuntimeCmd, driverArg := copilotSDKDriverExecArgs(sdkDriverScriptName)
 			if driverArg != "" {


+      onPermissionRequest: approveAll,
+      ...(model ? { model } : {}),
+    });
+    const response = await session.sendAndWait({ prompt });


+      ...(model ? { model } : {}),
+    });
+
+    const response = await session.sendAndWait({ prompt });


+        onPermissionRequest: approveAll,
+        ...(model ? { model } : {}),
+      });
+      const response = await session.sendAndWait({ prompt });


+        if model:
+            create_kwargs["model"] = model
+        session = await client.create_session(**create_kwargs)
+        response = await session.send_and_wait(prompt)


Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-06-03T22:09:18Z

@copilot

merge main, recompile

update specification and docs and sample drivers that COPILOT_MODEL is a REQUIRED environment variable

Done in commits 1373e53 (main merged + lock files recompiled) and 9f6a72e:

Spec (copilot-sdk-driver-specification.md): COPILOT_MODEL updated to Required: Yes with MUST be non-empty; implementations MUST fail fast when unset, and the TypeScript example now validates model alongside the other required vars before proceeding.
Sample drivers: All four (node, typescript, python, ruby) now call their respective readRequiredEnv/read_required_env/requiredEnv helper for COPILOT_MODEL and pass it directly to createSession/create_session without any optional spreading.

pelikhan · 2026-06-03T22:20:01Z

@copilot merge main and recompile

…dk-driver-samples # Conflicts: # .github/workflows/daily-issues-report.lock.yml # .github/workflows/daily-model-inventory.lock.yml # .github/workflows/daily-skill-optimizer.lock.yml # .github/workflows/daily-workflow-updater.lock.yml # docs/src/content/docs/reference/copilot-sdk-driver-specification.md Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-06-03T22:28:08Z

@copilot merge main and recompile

Done — merged main (resolving conflicts in 4 lock files and the spec, keeping our COPILOT_MODEL as required) and recompiled all 239 workflows in the latest commit.

pelikhan · 2026-06-03T22:34:12Z

@copilot remove implicit support for .github/drivers folder. Always use full relative path to workfspace root in copilot-sdk-driver field.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…shell-safety comment Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-06-03T23:01:01Z

@copilot remove implicit support for .github/drivers folder. Always use full relative path to workfspace root in copilot-sdk-driver field.

Done. The implicit .github/drivers path prefix has been removed from the execution engine — copilot-sdk-driver values are now used directly as workspace-relative paths (e.g. .github/drivers/copilot_sdk_driver_sample_python.py). All four daily workflows and the validation/schema logic have been updated accordingly.

Also addressed two follow-up issues from code review:

Empty path segments (foo//bar, foo/) are now explicitly rejected by validation (commit $(git rev-parse --short HEAD))
Added a clarifying comment in the execution path confirming the validated value is safe to embed in the shell command

Copilot AI and others added 2 commits June 3, 2026 21:18

Add copilot SDK driver samples and wire daily workflows

e67db3d

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Refine custom driver path quoting and update generated locks

88c954f

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI assigned Copilot and pelikhan Jun 3, 2026

Copilot AI changed the title ~~Add Copilot SDK driver samples and wire daily workflows~~ Add multi-language Copilot SDK driver samples and wire daily workflows to exercise runtime installs Jun 3, 2026

Copilot created this pull request from a session on behalf of pelikhan June 3, 2026 21:23 View session

Copilot finished work on behalf of pelikhan June 3, 2026 21:23

Copilot AI requested a review from pelikhan June 3, 2026 21:23

Copilot started work on behalf of pelikhan June 3, 2026 21:33 View session

Copilot AI and others added 3 commits June 3, 2026 21:46

Make sample SDK drivers self-contained

5102812

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Refine Python sample driver output handling

8cdbe65

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Polish sample driver consistency and error handling

c844585

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan June 3, 2026 21:51

Merge branch 'main' into copilot/add-copilot-sdk-driver-samples

ae9c156

pelikhan marked this pull request as ready for review June 3, 2026 21:51

Copilot AI review requested due to automatic review settings June 3, 2026 21:51

Copilot started reviewing on behalf of pelikhan June 3, 2026 21:51 View session

github-actions Bot mentioned this pull request Jun 3, 2026

[Contribution Check Report] Contribution Check — 2026-06-03 #36559

Closed

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Copilot started work on behalf of pelikhan June 3, 2026 21:59 View session

Copilot AI and others added 2 commits June 3, 2026 22:07

chore: plan for COPILOT_MODEL required update and recompile

1373e53

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

feat: make COPILOT_MODEL a required env var in drivers, spec, and docs

2a4e28e

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan June 3, 2026 22:09

Copilot started work on behalf of pelikhan June 3, 2026 22:20 View session

chore: merge main and recompile lock files

e803bc9

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan June 3, 2026 22:28

Copilot started work on behalf of pelikhan June 3, 2026 22:34 View session

Copilot AI and others added 2 commits June 3, 2026 22:54

Remove implicit .github/drivers path; recompile 4 daily workflows

0ae7c68

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Reject empty path segments in copilot-sdk-driver validation; clarify …

f6aa3e3

…shell-safety comment Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan June 3, 2026 23:01

pelikhan merged commit da79357 into main Jun 4, 2026

pelikhan deleted the copilot/add-copilot-sdk-driver-samples branch June 4, 2026 00:08

github-actions Bot mentioned this pull request Jun 4, 2026

Smoke Test: Codex - 26921903180 #36771

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add multi-language Copilot SDK driver samples and wire daily workflows to exercise runtime installs#36734

Add multi-language Copilot SDK driver samples and wire daily workflows to exercise runtime installs#36734
pelikhan merged 12 commits into
mainfrom
copilot/add-copilot-sdk-driver-samples

Copilot AI commented Jun 3, 2026 •

edited

Loading

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		driverRuntimeCmd, driverArg := copilotSDKDriverExecArgs(sdkDriverScriptName)
		if driverArg != "" {

Conversation

Copilot AI commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

pelikhan commented Jun 3, 2026

Uh oh!

Copilot AI commented Jun 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jun 3, 2026 •

edited

Loading