feat: add `job.workflow_*` typed accessors to JobContext by salmanmkc · Pull Request #4334 · actions/runner

salmanmkc · 2026-04-10T13:28:04Z

Summary

Adds typed C# accessors for the four new job expression context properties, enabling reusable workflows to determine their own source identity at runtime.

New properties

Expression	Description
`job.workflow_ref`	Full ref: `owner/repo/.github/workflows/file.yml@refs/heads/branch`
`job.workflow_sha`	Commit SHA of the resolved workflow file
`job.workflow_repository`	`owner/repo` of the workflow file
`job.workflow_file_path`	`.github/workflows/file.yml`

Changes

Runner.Worker/JobContext.cs — 4 string accessors (WorkflowRef, WorkflowSha, WorkflowRepository, WorkflowFilePath) + DeriveWorkflowRefComponents() to derive repository and file path from the composite workflow_ref
Runner.Worker/ExecutionContext.cs — Calls DeriveWorkflowRefComponents() after hydrating job context from server ContextData
Test/L0/Worker/JobContextL0.cs — 20 unit tests covering get/set/null for all properties + 5 derivation scenarios
Test/L0/Worker/ExecutionContextL0.cs — 3 integration tests: flag enabled (hydrates + derives), flag disabled (nothing set), server-sends-all-fields (no overwrite)

This PR adds:

Typed accessors following the same pattern as CheckRunId, Status, Container, Services
Derivation fallback in case server only sends workflow_ref without the decomposed fields

Part of https://github.com/github/c2c-actions/issues/10025

Adds typed C# accessors for workflow_ref, workflow_sha, workflow_repository, and workflow_file_path to JobContext. Includes DeriveWorkflowRefComponents() to derive repository and file_path from workflow_ref if not sent by server. Not strictly required — the run-service already sends all 4 fields and the existing blanket copy populates them in expressions. This is a code quality improvement for typed access and a fallback safety net. Part of ADR 10024 / c2c-actions#10025

Copilot

Pull request overview

Adds typed accessors on JobContext for new job.workflow_* expression context properties and a fallback derivation step so reusable workflows can identify their own source at runtime.

Changes:

Added WorkflowRef, WorkflowSha, WorkflowRepository, and WorkflowFilePath typed accessors on JobContext, plus DeriveWorkflowRefComponents() to parse workflow_ref.
Updated ExecutionContext.InitializeJob to derive workflow_repository and workflow_file_path after hydrating the job context.
Added L0 tests covering get/set/null semantics for the new accessors and verification of hydration/derivation behavior in ExecutionContext.

Show a summary per file

File	Description
src/Runner.Worker/JobContext.cs	Introduces typed accessors for `workflow_*` and adds derivation from `workflow_ref`.
src/Runner.Worker/ExecutionContext.cs	Calls workflow-ref derivation after job context hydration.
src/Test/L0/Worker/JobContextL0.cs	Adds unit tests for the new accessors and derivation scenarios.
src/Test/L0/Worker/ExecutionContextL0.cs	Adds initialization tests validating hydration/derivation behavior across feature-flag scenarios.

Copilot's findings

Files reviewed: 4/4 changed files
Comments generated: 4

Copilot · 2026-04-10T13:33:12Z

+                // Derive workflow_repository and workflow_file_path from workflow_ref
+                // if the server sent workflow_ref but not the decomposed fields
+                jobContext.DeriveWorkflowRefComponents();
            }


InitializeJob currently hydrates the entire job expression context (including the new workflow_* fields) only when Constants.Runner.Features.AddCheckRunIdToJobContext is enabled. The PR description indicates the workflow identity fields are gated by a different feature flag (actions_expose_job_workflow_context), so with the current implementation the runner will ignore server-sent workflow_* values unless the unrelated check-run-id flag is also on. Consider introducing/using a dedicated feature flag for the workflow identity context (or otherwise decoupling workflow identity hydration from the check-run-id flag) so the behavior matches the intended rollout gate.

Copilot · 2026-04-10T13:33:13Z

+            // Format: owner/repo/path/to/file.yml@ref
+            var atIndex = workflowRef.IndexOf('@');
+            var pathPart = atIndex >= 0 ? workflowRef.Substring(0, atIndex) : workflowRef;
+
+            // Split into owner/repo and file path at the .github/ boundary
+            var githubDirIndex = pathPart.IndexOf("/.github/");
+            if (githubDirIndex < 0)
+            {
+                return;
+            }


DeriveWorkflowRefComponents() uses pathPart.IndexOf("/.github/") without specifying StringComparison. For parsing protocol/identifier strings (like workflow refs) the codebase often uses ordinal comparisons to avoid culture-sensitive behavior and improve predictability. Consider using IndexOf("/.github/", StringComparison.Ordinal) (and similarly for other string searches) here.

Copilot · 2026-04-10T13:33:13Z

+                // Arrange: Create a job request message with the feature flag enabled
+                var variables = new Dictionary<string, VariableValue>()
+                {
+                    [Constants.Runner.Features.AddCheckRunIdToJobContext] = new VariableValue("true"),
+                };
+                var jobRequest = new Pipelines.AgentJobRequestMessage(new TaskOrchestrationPlanReference(), new TimelineReference(), Guid.NewGuid(), "some job name", "some job name", null, null, null, variables, new List<MaskHint>(), new Pipelines.JobResources(), new Pipelines.ContextData.DictionaryContextData(), new Pipelines.WorkspaceOptions(), new List<Pipelines.ActionStep>(), null, null, null, null, null);


These new workflow-identity tests toggle Constants.Runner.Features.AddCheckRunIdToJobContext. If workflow identity exposure is intended to be gated by a dedicated feature flag (as described in the PR metadata), these tests (and the production gate) should be updated to use the workflow-identity flag instead; otherwise the tests are implicitly asserting that workflow identity is coupled to the check-run-id rollout.

Copilot · 2026-04-10T13:33:13Z

+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Worker")]
+        public void InitializeJob_WorkflowIdentityDerived_WhenServerSendsAllFields()


Test name InitializeJob_WorkflowIdentityDerived_WhenServerSendsAllFields is misleading: the assertions verify that explicit workflow_repository/workflow_file_path values from the server are preserved (i.e., derivation does not overwrite). Consider renaming to reflect the non-overwrite behavior so the intent is clear when the test fails.

Suggested change

public void InitializeJob_WorkflowIdentityDerived_WhenServerSendsAllFields()

public void InitializeJob_WorkflowIdentityNotOverwritten_WhenServerSendsAllFields()

Fixes incorrect parsing for repos named .github (e.g. octo-org/.github). The old /.github/ marker would match too early, deriving the wrong repository name. Also treats empty-string fields as unset during derivation.

- Remove AddCheckRunIdToJobContext flag gate from job context hydration. The flag is permanently force-true server-side (acquirejobhandler.go:1658). The server controls what to send via its own feature flags. - Add owner/repo format validation to DeriveWorkflowRefComponents() - Add tests for PR merge refs, tag refs, invalid repo format, and .github repo names - Update check_run_id flag-disabled test to reflect always-copy behavior

salmanmkc requested a review from a team as a code owner April 10, 2026 13:28

Copilot AI review requested due to automatic review settings April 10, 2026 13:28

Copilot started reviewing on behalf of salmanmkc April 10, 2026 13:28 View session

Merge branch 'main' into adr-10024/job-workflow-context

5806ab5

Copilot AI reviewed Apr 10, 2026

View reviewed changes

salmanmkc added 2 commits April 10, 2026 13:51

fix: use /.github/workflows/ marker for derivation parsing

4342a1b

Fixes incorrect parsing for repos named .github (e.g. octo-org/.github). The old /.github/ marker would match too early, deriving the wrong repository name. Also treats empty-string fields as unset during derivation.

salmanmkc mentioned this pull request Apr 10, 2026

feat: add job.workflow_* typed accessors to JobContext #4335

Merged

salmanmkc closed this Apr 10, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `job.workflow_*` typed accessors to JobContext#4334

feat: add `job.workflow_*` typed accessors to JobContext#4334
salmanmkc wants to merge 4 commits intomainfrom
adr-10024/job-workflow-context

salmanmkc commented Apr 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	public void InitializeJob_WorkflowIdentityDerived_WhenServerSendsAllFields()
	public void InitializeJob_WorkflowIdentityNotOverwritten_WhenServerSendsAllFields()

Conversation

salmanmkc commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New properties

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

salmanmkc commented Apr 10, 2026 •

edited

Loading