Skip to content

Commit 3c0455e

Browse files
committed
docs(webapp): add JSDoc to overridable trigger/otel variable resolvers
1 parent e37f7ad commit 3c0455e

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

apps/webapp/app/v3/environmentVariables/environmentVariablesRepository.server.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -941,6 +941,13 @@ function renameVariables(variables: EnvironmentVariable[], renameMap: Record<str
941941
});
942942
}
943943

944+
/**
945+
* Resolves trigger-side built-in environment variables that are merged into a
946+
* task run's env but can be overridden by user-defined variables on the
947+
* environment. Values come from server-level `env` and are surfaced to runners
948+
* so they can pick up rollouts (e.g. the realtime stream version) without a
949+
* redeploy.
950+
*/
944951
async function resolveOverridableTriggerVariables(
945952
runtimeEnvironment: RuntimeEnvironmentForEnvRepo
946953
) {
@@ -1088,6 +1095,12 @@ async function resolveBuiltInDevVariables(runtimeEnvironment: RuntimeEnvironment
10881095
return [...result, ...commonVariables];
10891096
}
10901097

1098+
/**
1099+
* Resolves the OpenTelemetry collector endpoint advertised to dev (CLI) task
1100+
* runs. Defaults to the webapp's own `/otel` route under `APP_ORIGIN` so a
1101+
* vanilla self-host works without extra wiring; `DEV_OTEL_EXPORTER_OTLP_ENDPOINT`
1102+
* can override it to point spans/logs at an external collector.
1103+
*/
10911104
async function resolveOverridableOtelDevVariables(
10921105
runtimeEnvironment: RuntimeEnvironmentForEnvRepo
10931106
) {

0 commit comments

Comments
 (0)