← Back to issue list

docs: document volume environment variables

View original Github issue

Metadata

Project
imagecraft
Number
#506
Type
pull request
State
open
Author
copilot-swe-agent
Labels
—
Created
Updated
Closed
—

Current evaluation

Adds documentation for CRAFT_VOLUME_* environment variables to the step execution environment reference, fixing #505. Clean +14/-0 doc-only change, CI passing, awaiting review.

Suggested action: needs review

Reason: This is a straightforward documentation-only PR (+14/-0 lines) that fills a gap in the step execution environment reference by documenting the CRAFT_VOLUME_* environment variables already implemented in lifecycle.py. CI is passing (Canonical CLA), there are no review comments, and it directly addresses issue #505. It is ready for maintainer review.

Evaluated by: mr-cal-bot

Impact: 20 Quick Win: 15 Complexity: 5 Confidence: 85 Actionability: 80

Issue body

The step execution environment reference did not describe the variables that expose volume image files and partition devices. - **Reference update:** Documented `CRAFT_VOLUME_<VOLUME>` for raw image files and `CRAFT_VOLUME_<VOLUME>_<PARTITION>` for partition devices. Names are uppercased, with slashes and hyphens replaced by underscores. - **Example:** For volume `pc` and partition `rootfs`, the variables are: ```bash echo "$CRAFT_VOLUME_PC" echo "$CRAFT_VOLUME_PC_ROOTFS" ``` <!-- START COPILOT CODING AGENT SUFFIX --> - Fixes #505

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 15
Complexity: 5
Confidence: 85
Actionability: 80
needs review Adds documentation for CRAFT_VOLUME_* environment variables to the step execution environment reference, fixing #505. Clean +14/-0 doc-only change, CI passing, awaiting review.

Update history

Date Change
created

Related work

  • Related To: imagecraft#505 (confidence 100%)

    This PR directly implements the documentation request from issue #505.

Related issues

Issue Project State Summary Similarity
#505 Document the volumes environment variables imagecraft open Documentation request to add CRAFT_VOLUME_* environment variables to the step execution environment reference page. A related PR (#506) exists but is awaiting review.
88%
#431 docs: add environment variables reference craft-application merged Merged #431 added a 112-line environment-variable reference, including CRAFT_VERBOSITY_LEVEL, via commit 1509cec9.
73%