Skip to content

chore: align env_vars defaults key order with the workspace canonical order#28

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/env-vars-profile-key-order
Jul 23, 2026
Merged

chore: align env_vars defaults key order with the workspace canonical order#28
Jammy2211 merged 1 commit into
mainfrom
feature/env-vars-profile-key-order

Conversation

@Jammy2211

Copy link
Copy Markdown
Contributor

Summary

This repo carries only the smoke profile (config/build/env_vars.yaml). Across the workspace, the smoke and release profiles listed the same keys in different orders, so they could not be read or diffed side by side. This applies the workspace-wide canonical key order to this repo's defaults: block and aligns the trailing comment column, so it matches its siblings.

Canonical order (union of every key in use across the workspace, smoke-first):

PYAUTO_TEST_MODE
PYAUTO_SKIP_FIT_OUTPUT
PYAUTO_SKIP_VISUALIZATION
PYAUTO_SKIP_CHECKS
PYAUTO_SMALL_DATASETS
PYAUTO_DISABLE_JAX
PYAUTO_FAST_PLOTS
PYAUTO_SKIP_WORKSPACE_VERSION_CHECK
JAX_ENABLE_X64
MPLBACKEND
NUMBA_CACHE_DIR
MPLCONFIGDIR

No keys added or removed, no values changed, each key keeps its own comment text, and overrides: is untouched (it is an ordered list of pattern rules where order is load-bearing).

Provably a no-op. defaults is applied by plain dict iteration in PyAutoHands/autohands/env_config.py, so its order cannot affect the resolved environment.

Scripts Changed

None — configuration only. No file under scripts/ is touched, so no notebook regeneration is involved.

  • config/build/env_vars.yamldefaults: comment column aligned to the canonical layout.

Test Plan

  • Resolved-env diff before/after: for every script in the repo × both profiles, resolved from an empty base via resolve_clean() (PyAutoHands/autohands/validate_env_profiles.py). Identical — this is a strictly stronger check than a smoke run for a config-only change, since it proves every script's environment is byte-for-byte unchanged rather than sampling a subset.
  • validate_env_profiles.py verdict byte-identical to main (no new errors or warnings).
  • git diff --stat contains nothing but config/build/env_vars*.yaml.
  • diff of the two profiles' defaults: blocks now shows only genuine value/comment differences, with keys lining up row-for-row.

Part of a workspace-wide sweep across 10 repos. Refs PyAutoLabs/autolens_workspace#321.

Generated by the PyAutoLabs agent workflow.

Apply one canonical key order to the `defaults:` block of every
config/build/env_vars*.yaml so the smoke and release profiles line up
row-for-row and can be diffed side by side, and align the trailing
comment column.

No keys added or removed, no values changed, `overrides:` untouched.
Provably a no-op: `defaults` is applied by plain dict iteration
(PyAutoHands/autohands/env_config.py), so its order cannot affect the
resolved environment.

Refs PyAutoLabs/autolens_workspace#321
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 23, 2026
@Jammy2211
Jammy2211 merged commit 08ee9a5 into main Jul 23, 2026
10 checks passed
@Jammy2211
Jammy2211 deleted the feature/env-vars-profile-key-order branch July 23, 2026 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant