← Back to issue list

Docs: Document/cross-reference working directory and environment variables of override-* steps

View original Github issue

Metadata

Project
craft-parts
Number
#659
Type
issue
State
open
Author
thp-canonical
Labels
—
Created
Updated
Closed
—

Current evaluation

Open, untriaged documentation gap: Part properties does not cross-reference step environments, leaving override-pull/build/stage/prime working directories and variables hard to find.

Suggested action: needs triage

Reason: The current part-properties page includes all four override fields but has no reference to the existing step execution environment documentation, which lists CRAFT_STAGE, CRAFT_PRIME, and other variables. The request is well scoped, but there is no human assessment: it has no labels and its sole comment is an automated Jira-creation notice.

Evaluated by: mr-cal-bot

Impact: 35 Quick Win: 22 Complexity: 24 Confidence: 92 Actionability: 84

Issue body

### What needs to get done Document (or cross-reference) the current working directory and available environment variables for `override-build`, `override-prime`, `override-pull` and `override-stage`, so that they are easy to find from the "Part properties" documentation: https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/part_properties.html#override-build Probably requires cross-referencing https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/parts_steps.html#step-execution-environment from the above page (and the other `override-*` steps). ### Why it needs to get done It's not clear by just looking at [the documentation](https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/part_properties.html#override-build) in which directory the `override-build`, `override-prime`, `override-pull` and `override-stage` steps run, and in e.g. `override-prime` where "stage" and where "prime" is relative to the current directory (I assume it'll be `$CRAFT_STAGE` and `$CRAFT_PRIME`, but is the working directory one of them already?).

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 35
Quick Win: 22
Complexity: 24
Confidence: 92
Actionability: 84
needs triage Open, untriaged documentation gap: Part properties does not cross-reference step environments, leaving override-pull/build/stage/prime working directories and variables hard to find.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 10
Confidence: 75
Actionability: 70
needs triage Documentation request to cross-reference working directory and environment variables for override-* steps from part_properties docs to step_execution_environment docs.
qwen/qwen3.8-27b
Impact: 30
Quick Win: 26
Staleness: 70
Complexity: 15
Confidence: 75
Support Request: 20
needs triage Docs gap: part_properties.rst override-build/prime/stage/pull entries lack cross-references to step execution environment (working directory, CRAFT_* env vars). Unlabeled, only a Jira-sync bot comment; docs still not cross-referenced.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 15
Confidence: 85
Support Request: 10
needs triage Documentation request to clarify working directories and environment variables for override-* steps. Unlabelled, untriaged, and inactive for over two years with only a Jira sync comment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 95
Complexity: 10
Confidence: 80
Support Request: 5
close stale Documentation request to clarify working directories and environment variables for override steps. Untriaged and inactive for over two years with no maintainer engagement.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.