Skip to content

Add active engine version inventory and runner identifier to gh-aw-metadata#36964

Merged
pelikhan merged 10 commits into
mainfrom
copilot/update-gh-aw-metadata-payload
Jun 4, 2026
Merged

Add active engine version inventory and runner identifier to gh-aw-metadata#36964
pelikhan merged 10 commits into
mainfrom
copilot/update-gh-aw-metadata-payload

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 4, 2026

gh-aw-metadata currently lacks engine runtime version context and runner identity, which limits downstream traceability. This change extends the frontmatter-derived metadata payload to include normalized engine versions and the agent image runner identifier (with structured runs-on values serialized).

  • Metadata contract updates

    • Extend lock metadata with:
      • engine_versions: { "<engine>": "<version>" }
      • agent_image_runner: "<runner-id-or-serialized-runs-on>"
    • Wire new fields through generation + JSON serialization/deserialization paths.
  • Engine version population

    • Record versions only for engines that are active in the current workflow:
      • the main workflow engine
      • the threat-detection engine when threat detection is enabled
    • Apply configured engine version overrides when explicitly set for active engines.
    • Include copilot-sdk version only when engine.copilot-sdk: true is enabled on an active Copilot engine.
  • Runner identifier capture

    • Derive runner identity from frontmatter runs-on.
    • Preserve string values as-is.
    • Serialize array/object forms to stable JSON for metadata storage.
  • Test coverage

    • Add targeted tests for:
      • metadata field persistence in lock generation
      • JSON round-trip for new metadata fields
      • engine version map behavior for active engines (defaults + overrides + copilot-sdk)
      • runner identifier serialization behavior
# lock header
# gh-aw-metadata: {
#   "schema_version":"v4",
#   "frontmatter_hash":"...",
#   "engine_versions":{
#     "copilot":"1.0.57",
#     "copilot-sdk":"1.0.0"
#   },
#   "agent_image_runner":"[\"self-hosted\",\"linux\"]"
# }

Updated branch via pr-sous-chef in run https://github.com/github/gh-aw/actions/runs/26971599086. Please rebuild the metadata payload and rerun checks.

Generated by 👨‍🍳 PR Sous Chef · gpt54mini 4.4M ·


pr-sous-chef updated the branch in https://github.com/github/gh-aw/actions/runs/26974695546

Generated by 👨‍🍳 PR Sous Chef · gpt54mini 5.9M ·

Copilot AI and others added 3 commits June 4, 2026 17:26
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title Add engine versions and runner identifier to gh-aw metadata Add engine version inventory and runner identifier to gh-aw-metadata Jun 4, 2026
Copilot AI requested a review from pelikhan June 4, 2026 17:31
Copy link
Copy Markdown
Collaborator

@pelikhan pelikhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot only log engine version that are "active" in the current AW

@pelikhan
Copy link
Copy Markdown
Collaborator

pelikhan commented Jun 4, 2026

@copilot must still be a single line JSONL payload

@pelikhan
Copy link
Copy Markdown
Collaborator

pelikhan commented Jun 4, 2026

@copilot check that gh-aw-manifest does not duplicate this info.m

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot only log engine version that are "active" in the current AW

Updated in commit de67ab2. engine_versions now only includes engines active in the current workflow (main engine plus active threat-detection engine when applicable), with overrides preserved and copilot-sdk included only when active.

Copilot AI changed the title Add engine version inventory and runner identifier to gh-aw-metadata Add active engine version inventory and runner identifier to gh-aw-metadata Jun 4, 2026
Copilot AI requested a review from pelikhan June 4, 2026 18:09
Copilot AI and others added 2 commits June 4, 2026 18:15
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot check that gh-aw-manifest does not duplicate this info.m

Checked and enforced in f5b1749. Added a test that parses gh-aw-manifest and asserts it does not include engine_versions or agent_image_runner (metadata-only fields).

@copilot must still be a single line JSONL payload

Addressed in f5b1749. Added assertions that both gh-aw-metadata and gh-aw-manifest header payloads remain single-line JSON strings in compiled lock files.

@pelikhan pelikhan marked this pull request as ready for review June 4, 2026 18:29
Copilot AI review requested due to automatic review settings June 4, 2026 18:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@pelikhan
Copy link
Copy Markdown
Collaborator

pelikhan commented Jun 4, 2026

@copilot Merge main and recompile

Copilot stopped reviewing on behalf of pelikhan due to an error June 4, 2026 19:29
…metadata-payload

# Conflicts:
#	.github/workflows/contribution-check.lock.yml

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

Please rebase on main, rerun the metadata compile, and push the result.

Generated by 👨‍🍳 PR Sous Chef · gpt54mini 5.9M ·

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot Merge main and recompile

Done in 5d864c1 (merge) and 5ce848e. Merged origin/main, resolved the single conflict in contribution-check.lock.yml, built, and recompiled all 240 workflow lock files successfully.

@pelikhan pelikhan merged commit 64f1164 into main Jun 4, 2026
22 of 23 checks passed
@pelikhan pelikhan deleted the copilot/update-gh-aw-metadata-payload branch June 4, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants