Step execution environment documentation is incomplete and out of date
Metadata
Current evaluation
Closed and deferred to internal Jira ticket CRAFT-3846. No documentation updates or code changes were implemented. The request was abandoned on GitHub.
Suggested action: —
No scores available.
Issue body
### What needs to get done
The [Step execution environment documentation](https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/parts_steps.html#step-execution-environment) is incomplete, missing at least the following:
- `CRAFT_ARCH_BUILD_ON`
- `CRAFT_ARCH_BUILD_FOR`
- `CRAFT_ARCH_TRIPLET_BUILD_ON`
- `CRAFT_ARCH_TRIPLET_BUILD_FOR`
- `CRAFT_STEP_NAME`
The first four of those are especially problematic since they [replace deprecated keys](https://github.com/canonical/craft-parts/blob/1a2631e13bd707a9e3d53d157c71ce308d9b5a7a/craft_parts/executor/environment.py#L317-L323), and the documentation doesn't note that `CRAFT_ARCH_TRIPLET` and `CRAFT_TARGET_ARCH` are deprecated.
It also doesn't include several changes to existing environment variables that we make, including:
- Prepending a large number of directories to `$PATH` (roughly equivalent to exporting `PATH=$CRAFT_PART_INSTALL/usr/sbin:$CRAFT_PART_INSTALL/usr/bin:$CRAFT_PART_INSTALL/sbin:$CRAFT_PART_INSTALL/bin:$CRAFT_STAGE/usr/sbin:$CRAFT_STAGE/usr/bin:$CRAFT_STAGE/sbin:$CRAFT_STAGE/bin:$PATH`)
- Similar changes to `CPPFLAGS`, `CFLAGS`, `CXXFLAGS`
- Related changes to `LDFLAGS`
- Similar changes to `PKG_CONFIG_PATH`
### Why it needs to get done
The former group can be frustrating for users who don't know what to do about our deprecation notice, and the latter can cause confusion to users if, for example, an unexpected executable gets run.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Closed and deferred to internal Jira ticket CRAFT-3846. No documentation updates or code changes were implemented. The request was abandoned on GitHub. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed and synced to Jira ticket CRAFT-3846. No documentation updates or fixes were implemented on GitHub. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without resolution. Synced to Jira as CRAFT-3846. Documentation updates for step execution environment variables and deprecated keys remain pending. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed and abandoned. Documentation updates were deferred to internal tracking via Jira ticket CRAFT-3846. No code changes or documentation fixes were implemented. |
Update history
No update history recorded yet.
Related issues
No related issues found above the similarity threshold.