← Back to issue list

Step execution environment documentation is incomplete and out of date

View original Github issue

Metadata

Project
craft-parts
Number
#948
Type
issue
State
closed
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Updated and completed the step execution environment documentation in PR #949, merged as commit c6dc5665, covering missing architecture variables, deprecated keys, and PATH/compiler/linker/pkg-config changes.

Resolution: closed resolved

Reason: Documentation changes were merged in PR #949 via commit c6dc5665. The resulting reference documents the missing variables, deprecations, and modifications to PATH, compiler flags, linker flags, and PKG_CONFIG_PATH.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Updated and completed the step execution environment documentation in PR #949, merged as commit c6dc5665, covering missing architecture variables, deprecated keys, and PATH/compiler/linker/pkg-config changes.
stealth/space-bunny-alpha — closed resolved Updated the step environment documentation in canonical/craft-parts PR #949 (commit c6dc5665), covering architecture variables, deprecations, and modified build variables.
stealth/space-bunny-alpha — closed resolved Documentation was completed in merged PR #949 (commit c6dc5665), adding missing variables, architecture-key deprecations, and PATH, compiler, linker, and pkg-config path behavior.
stealth/space-bunny-alpha — closed resolved Merged PR #949 (commit c6dc5665) completed the step environment reference, documenting missing variables, deprecated architecture keys, and changes to PATH, compiler/linker flags, and PKG_CONFIG_PATH.
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 work

  • Likely Fixed By: canonical/craft-parts#949 (confidence 100%)

    Merged PR #949 is identified as the resolving change and is associated with commit c6dc5665.

Related issues

Issue Project State Summary Similarity
#949 docs: update and complete the step execution environment craft-parts merged Merged PR #949 as commit c6dc5665 (CRAFT-3846): completed the step execution environment docs, adding missing env vars and noting CRAFT_TARGET_ARCH/CRAFT_ARCH_TRIPLET deprecation. Fixes #948.
76%