Inject GH_AW_ENGINE_VERSION into custom engine execution steps by Copilot · Pull Request #50597 · github/gh-aw

Copilot · 2026-08-05T15:36:06Z

engine.version was parsed and used for installation but never injected into the main agent execution environment for behavior-defined engines (Goose, Ader, Crush, etc.), making it inaccessible to scripts at runtime. Version was already in safe-outputs jobs and audit info (GH_AW_INFO_VERSION).

Changes

engine_helpers.go — New applyEngineVersionEnv helper sets GH_AW_ENGINE_VERSION from EngineConfig.Version; supports literal strings and GHA expressions (${{ inputs.engine-version }})
behavior_defined_engine.go — Calls applyEngineVersionEnv in buildBehaviorDefinedExecutionEnv, alongside existing applyEngineCwdEnv
Tests — Unit tests for the helper; execution-step integration tests asserting presence/absence of GH_AW_ENGINE_VERSION

engine:
  id: goose
  version: "1.2.3"   # now available as GH_AW_ENGINE_VERSION in the run step

Audit logging (GH_AW_INFO_VERSION / GH_AW_INFO_AGENT_VERSION) already covered custom engines via getInstallationVersion — no changes needed there.

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

Copilot

Pull request overview

Injects configured engine versions into behavior-defined engine execution environments.

Changes:

Adds applyEngineVersionEnv.
Applies it during custom engine execution.
Covers literal, expression, absent, and nil configurations.

Show a summary per file

File	Description
`pkg/workflow/engine_helpers.go`	Adds version environment helper.
`pkg/workflow/engine_helpers_test.go`	Tests helper behavior.
`pkg/workflow/behavior_defined_engine.go`	Injects version into execution environments.
`pkg/workflow/behavior_defined_engine_harness_test.go`	Tests rendered execution steps.

Review details

Tip

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

Files reviewed: 4/4 changed files
Comments generated: 0
Review effort level: Balanced

github-actions · 2026-08-05T16:43:19Z

✅ Test Quality Sentinel completed test quality analysis.

github-actions · 2026-08-05T16:43:22Z

✅ PR Code Quality Reviewer completed the code quality review.

pelikhan · 2026-08-05T16:43:25Z

@copilot update goose.md, crush.md, opencode.md, aider.com to declare their version in the front matter and use the version variable in the generate code

github-actions · 2026-08-05T16:43:25Z

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

github-actions · 2026-08-05T16:43:37Z

✅ Design Decision Gate 🏗️ completed the design decision gate check.

github-actions · 2026-08-05T16:48:41Z

🧪 Test Quality Sentinel Report

✅ Test Quality Score: 90/100 — Excellent

Analyzed 2 test(s): 2 design, 0 implementation, 0 violation(s).

📊 Metrics (2 tests)

Metric	Value
Analyzed	2 (Go: 2, JS: 0)
✅ Design	2 (100%)
⚠️ Implementation	0 (0%)
Edge/error coverage	2 (100%)
Duplicate clusters	0
Inflation	YES (test:prod ratio >2:1 in both files)
🚨 Violations	0

Test	File	Classification	Issues
`TestBehaviorDefinedEngineVersionEnvInjection`	`behavior_defined_engine_harness_test.go`	`design_test` / `behavioral_contract` / `high_value`	Inflation (51 test lines : 1 prod line)
`TestApplyEngineVersionEnv`	`engine_helpers_test.go`	`design_test` / `behavioral_contract` / `high_value`	Inflation (57 test lines : 11 prod lines)

Verdict

✅ passed. 0% implementation tests (threshold: 30%). Score capped from 100 to 90 for test:prod line inflation (both files exceed 2:1), but this is expected when small production helpers receive thorough nil/empty/expression/absent edge coverage. No violations detected.

🧪 Test quality analysis by Test Quality Sentinel · sonnet46 · 37.8 AIC · ⌖ 10.9 AIC · ⊞ 7.7K · ◷
_{Comment /review to run again}

github-actions

✅ Test Quality Sentinel: 90/100. 0% implementation tests (threshold: 30%).

pelikhan · 2026-08-05T16:49:39Z

@copilot run pr-finisher skill

github-actions

The implementation is correct and well-tested. applyEngineVersionEnv is properly nil-guarded, follows the existing helper pattern, and is correctly scoped to behavior-defined (custom) engines only. Test coverage handles nil, empty, literal, and expression cases.> 🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · sonnet46 · 12.6 AIC · ⌖ 9.25 AIC · ⊞ 5.4K

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

github-actions · 2026-08-05T16:55:29Z

Design Decision Gate - ADR Required

This PR makes significant changes to core business logic (120 new lines in pkg/workflow/) but does not have a linked Architecture Decision Record (ADR).

Draft ADR committed: docs/adr/50597-inject-engine-version-env-into-behavior-defined-engines.md - review and complete it before merging.

This PR cannot merge until an ADR is linked in the PR body.

What to do next

Review the draft ADR committed to your branch - it was generated from the PR diff
Complete the missing sections - add context the AI could not infer, refine the decision rationale, and list real alternatives you considered
Commit the finalized ADR to docs/adr/ on your branch
Reference the ADR in this PR body by adding a line such as:

ADR: ADR-50597: Inject Engine Version Env into Behavior-Defined Engines

Once an ADR is linked in the PR body, this gate will re-run and verify the implementation matches the decision.

Why ADRs Matter

ADRs create a searchable, permanent record of why the codebase looks the way it does. Future contributors (and your future self) will thank you.

Michael Nygard ADR Format Reference

An ADR must contain these four sections to be considered complete:

Context - What is the problem? What forces are at play?
Decision - What did you decide? Why?
Alternatives Considered - What else could have been done?
Consequences - What are the trade-offs (positive and negative)?

All ADRs are stored in docs/adr/ as Markdown files numbered by PR number.

🏗️ ADR gate enforced by Design Decision Gate 🏗️ · sonnet46 · 50.7 AIC · ⌖ 22.3 AIC · ⊞ 4.4K · ◷
_{Comment /review to run again}

github-actions

Skills-Based Review 🧠

Applied /tdd and /codebase-design — changes are solid, approving.

📋 Key Themes & Highlights

Positive Highlights

✅ applyEngineVersionEnv follows the same nil-guard and early-return pattern as applyEngineCwdEnv — consistent with existing conventions
✅ Unit tests cover all five cases: nil data, nil config, empty version, literal version, and GHA expression
✅ Integration harness tests confirm both injection and absence end-to-end
✅ Raw expression (${{ inputs.engine-version }}) is passed through unchanged — correct, since GHA evaluates it at runtime
✅ Call-site ordering in buildBehaviorDefinedExecutionEnv is logical alongside applyEngineCwdEnv

> 🧠 *Reviewed using Matt Pocock's skills by [Matt Pocock Skills Reviewer](https://github.com/github/gh-aw/actions/runs/31024666042)* · sonnet46 · 16.2 AIC · ⌖ 10.7 AIC · ⊞ 7.1K > _{Comment /matt to run again}

github-actions

Verdict: COMMENT — no blocking issues

Small, well-tested addition that injects GH_AW_ENGINE_VERSION following the exact same pattern as the existing applyEngineCwdEnv/GH_AW_ENGINE_CWD helper (nil-safe checks, same YAML env rendering path via appendEnvVarLine, which already handles escaping/newlines). Coverage includes literal version, GHA-expression version, and absent-version cases at both the helper unit-test level and the execution-step integration level.

Notes considered

No new injection surface: reuses FormatStepWithCommandAndEnv → appendEnvVarLine, the same trusted path used for Cwd.
No validation of Version format, but this matches existing Cwd/MaxTurns handling — consistent with current conventions, not a regression.
Docs (PR body) accurately describe scope; audit-log injection (GH_AW_INFO_VERSION) was already covered and correctly left untouched.

> 🔎 *Code quality review by [PR Code Quality Reviewer](https://github.com/github/gh-aw/actions/runs/31024666349)* · auto · 82.4 AIC · ⌖ 9.2 AIC · ⊞ 7.9K > _{Comment /review to run again}

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

Copilot · 2026-08-05T16:59:56Z

@copilot update goose.md, crush.md, opencode.md, aider.com to declare their version in the front matter and use the version variable in the generate code

Implemented in 24883d0. The shared engine frontmatter now declares versions; Goose and Aider consume GH_AW_ENGINE_VERSION, while Crush and OpenCode use the declared engine version for generated npm installs. Recompiled lock files are included.

gh-aw-bot · 2026-08-05T17:01:44Z

@copilot please refresh this branch, address any remaining review feedback or failed checks, and run the pr-finisher skill before handing back for maintainer review.

Generated by 👨‍🍳 PR Sous Chef · gpt54 · 5.24 AIC · ⌖ 9.9 AIC · ⊞ 8.3K · ◷
_{Comment /souschef to run again}

pelikhan · 2026-08-05T17:05:00Z

  python:
    version: "3.12"
+env:
+  GH_AW_ENGINE_VERSION: "0.86.2"


@copilot not needed since it is populated by the compiller

Addressed in 1bb6e43. The compiler now sets GH_AW_ENGINE_VERSION at agent-job scope, so the Aider pre-agent install receives it without an imported top-level env declaration.

pelikhan · 2026-08-05T17:06:08Z

@copilot run pr-finisher skill

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

github-actions · 2026-08-06T06:24:40Z

🎉 This pull request is included in a new release.

Release: v0.85.4

Add GH_AW_ENGINE_VERSION env var injection for custom engines

243582a

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

Copilot AI assigned Copilot and pelikhan Aug 5, 2026

Copilot AI changed the title ~~Add GH_AW_ENGINE_VERSION env var injection for custom engine execution steps~~ Inject GH_AW_ENGINE_VERSION into custom engine execution steps Aug 5, 2026

Copilot finished work on behalf of pelikhan August 5, 2026 15:36

Copilot AI requested a review from pelikhan August 5, 2026 15:36

Copilot created this pull request from a session on behalf of pelikhan August 5, 2026 15:36 View session

pelikhan marked this pull request as ready for review August 5, 2026 16:18

Copilot AI balanced review requested due to automatic review settings August 5, 2026 16:18

Copilot started reviewing on behalf of pelikhan August 5, 2026 16:19 View session

Copilot AI reviewed Aug 5, 2026

View reviewed changes

Copilot started work on behalf of pelikhan August 5, 2026 16:44 View session

github-actions Bot approved these changes Aug 5, 2026

View reviewed changes

docs(adr): draft ADR-50597 for GH_AW_ENGINE_VERSION env injection

c9c9f83

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

github-actions Bot approved these changes Aug 5, 2026

View reviewed changes

github-actions Bot reviewed Aug 5, 2026

View reviewed changes

Use declared versions in custom engines

24883d0

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

Copilot finished work on behalf of pelikhan August 5, 2026 17:00

Copilot started work on behalf of pelikhan August 5, 2026 17:01 View session

github-actions Bot mentioned this pull request Aug 5, 2026

[pr-sous-chef] pr-sous-chef run report #50440

Closed

pelikhan reviewed Aug 5, 2026

View reviewed changes

Expose engine version to agent job steps

707d443

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

Copilot AI requested a review from pelikhan August 5, 2026 17:26

Copilot started work on behalf of pelikhan August 5, 2026 17:27 View session

pelikhan merged commit 9b24bbc into main Aug 5, 2026
30 checks passed

pelikhan deleted the copilot/add-engine-version-support branch August 5, 2026 18:10

Copilot finished work on behalf of pelikhan September 28, 2026 14:49

Conversation

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

Uh oh!

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

github-actions Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelikhan commented Aug 5, 2026

Uh oh!

github-actions Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 5, 2026

🧪 Test Quality Sentinel Report

Verdict

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Aug 5, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Aug 5, 2026

Design Decision Gate - ADR Required

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Skills-Based Review 🧠

Positive Highlights

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Verdict: COMMENT — no blocking issues

Uh oh!

Copilot AI commented Aug 5, 2026

Uh oh!

gh-aw-bot commented Aug 5, 2026

Uh oh!

pelikhan Aug 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 5, 2026

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Aug 5, 2026

Uh oh!

Uh oh!

github-actions Bot commented Aug 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Aug 5, 2026 •

edited

Loading

github-actions Bot commented Aug 5, 2026 •

edited

Loading

github-actions Bot commented Aug 5, 2026 •

edited

Loading

github-actions Bot commented Aug 5, 2026 •

edited

Loading

github-actions Bot commented Aug 5, 2026 •

edited

Loading