← 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

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.

Suggested action: needs triage

Reason: No maintainer has labelled, acknowledged, or assigned this docs improvement request; the only comment is the autogenerated Jira-sync bot (CRAFT-2490). The referenced step_execution_environment.rst exists and documents CRAFT_STAGE/CRAFT_PRIME, but part_properties.rst still has no cross-reference from the override-* entries, so the gap persists and the issue remains valid but untriaged.

Impact: 30 Quick Win: 25.5 Staleness: 70 Complexity: 15 Confidence: 75 Support Request: 20

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
qwen/qwen3.8-27b
Impact: 30
Quick Win: 25.5
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 88
Complexity: 10
Confidence: 75
Support Request: 0
close stale Document working directory and environment variables for override-build, override-prime, override-pull, and override-stage steps. Open, inactive since Feb 2024, auto-routed to Jira, awaiting documentation updates or triage.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.