Skip to content

Add JOB_ env vars #4053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jenseng wants to merge 1 commit into
base: main
Choose a base branch
from
+58 −3
Open

Add JOB_ env vars #4053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions src/Runner.Worker/JobContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
using GitHub.DistributedTask.Pipelines.ContextData;
using GitHub.DistributedTask.Pipelines.ContextData;
using GitHub.Runner.Common.Util;
using GitHub.Runner.Common;
using System;
using System.Collections.Generic;

namespace GitHub.Runner.Worker
{
public sealed class JobContext : DictionaryContextData
public sealed class JobContext : DictionaryContextData, IEnvironmentContextData
{
public ActionResult? Status
{
Expand Down Expand Up @@ -146,5 +148,33 @@ public string WorkflowFilePath
this["workflow_file_path"] = value != null ? new StringContextData(value) : null;
}
}

private readonly HashSet<string> _contextEnvAllowlist = new(StringComparer.OrdinalIgnoreCase)

@ericsciple ericsciple Apr 27, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks @jenseng! I want to collect some more thoughts internally.

I'm thinking about namespace conflict (if customers already use JOB_ variables). I'm waiting on one of the individuals to get back from vacation.

@jenseng jenseng Apr 27, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Yeah that's a fair point and definitely worth considering. Another possibility could be to have a GITHUB_JOB_ prefix, though that has some downsides of its own (i.e. inconsistent with how runner/github variables are named, and it could conflict with future github.job_... variables)

@ericsciple ericsciple Apr 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good callout on RUNNER_ variables 👍. That naming precedent helps.

We can likely add JOB_ but may need some advance announcement before it rolls out. I will discuss more with folks internally.

@jenseng jenseng Jul 1, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

👋 hey @ericsciple, any updates here?

thinking more about potential conflicts with (existing) JOB_ variables people might set, perhaps this could be done slightly more gradually with a feature flag...

before the feature is enabled, these new variables wouldn't get set. but if someone tries to set one of these reserved variable names (via env or $GITHUB_ENV), actions/runner would emit a warning that this will stop working (e.g. JOB_CHECK_RUN_ID is a reserved variable name, and you will no longer be able to set it as of $DATE. Please switch to a different variable name)

then once the feature flag is enabled, the new variables would get set automatically. then if someone tries to set one of them explicitly, the warning text would be slightly different (e.g. JOB_CHECK_RUN_ID is a reserved variable name, so the value you've set has no effect. Please switch to a different variable name)

that could be more trouble than it's worth though, so perhaps an advance announcement would suffice? 🤷‍♂️

it could also be good to add telemetry around the env variable names people are setting in their workflows/actions, which would give you better insights into how disruptive these kinds of changes might be

{
"check_run_id",
"status",
"workflow_ref",
"workflow_sha",
"workflow_repository",
"workflow_file_path",
};

public IEnumerable<KeyValuePair<string, string>> GetRuntimeEnvironmentVariables()
{
foreach (var data in this)
{
if (_contextEnvAllowlist.Contains(data.Key))
{
if (data.Value is StringContextData value)
{
yield return new KeyValuePair<string, string>($"JOB_{data.Key.ToUpperInvariant()}", value.ToString());
}
else if (data.Value is NumberContextData numberValue)
{
yield return new KeyValuePair<string, string>($"JOB_{data.Key.ToUpperInvariant()}", numberValue.ToString());
}
}
}
}
}
}
27 changes: 26 additions & 1 deletion src/Test/L0/Worker/JobContextL0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System;
using System.Collections.Generic;
using GitHub.DistributedTask.Pipelines.ContextData;
using GitHub.Runner.Worker;
using Xunit;
Expand Down Expand Up @@ -138,5 +139,29 @@ public void WorkflowFilePath_SetNull_ClearsValue()
ctx.WorkflowFilePath = null;
Assert.Null(ctx.WorkflowFilePath);
}

[Fact]
public void GetRuntimeEnvironmentVariables_ReturnsCorrectVariables()
{
var ctx = new JobContext();
ctx.CheckRunId = 12345;
ctx.Status = ActionResult.Success;
ctx.WorkflowRef = "owner/repo/.github/workflows/ci.yml@refs/heads/main";
ctx.WorkflowSha = "abc123def456";
ctx.WorkflowRepository = "owner/repo";
ctx.WorkflowFilePath = ".github/workflows/ci.yml";

var dict = new Dictionary<string, string>(ctx.GetRuntimeEnvironmentVariables());
Assert.Equal("12345", dict["JOB_CHECK_RUN_ID"]);
Assert.Equal("success", dict["JOB_STATUS"]);
Assert.Equal("owner/repo/.github/workflows/ci.yml@refs/heads/main", dict["JOB_WORKFLOW_REF"]);
Assert.Equal("abc123def456", dict["JOB_WORKFLOW_SHA"]);
Assert.Equal("owner/repo", dict["JOB_WORKFLOW_REPOSITORY"]);
Assert.Equal(".github/workflows/ci.yml", dict["JOB_WORKFLOW_FILE_PATH"]);

ctx = new JobContext();
dict = new Dictionary<string, string>(ctx.GetRuntimeEnvironmentVariables());
Assert.Empty(dict);
}
}
}