docs: document custom project vars (SNAPCRAFT-1053)
Metadata
Current evaluation
Merged in canonical/snapcraft#5727 as cba259a0d, documenting custom project variables for SNAPCRAFT-1053 after the work moved from canonical/craft-parts#1216.
Resolution: closed resolved
Reason: The PR was merged into Snapcraft as commit cba259a0d, adding 42 lines of documentation for custom project variables. Its body records that the work moved from canonical/craft-parts#1216.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [ ] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `make lint`?
- [ ] Have you successfully run `make test`?
---
Moved here from https://github.com/canonical/craft-parts/pull/1216 per suggestion of @mr-cal
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#5727 as cba259a0d, documenting custom project variables for SNAPCRAFT-1053 after the work moved from canonical/craft-parts#1216. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5727 in commit cba259a0d, documenting custom project variables for SNAPCRAFT-1053 after the work moved from canonical/craft-parts#1216. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR canonical/snapcraft#5727 (commit cba259a0d, 'docs: add how to set component version'), adding docs for custom SNAPCRAFT project variables for SNAPCRAFT-1053 after the work was moved from craft-parts#1216. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#5727 via commit cba259a0d, documenting custom project variables for SNAPCRAFT-1053 after the work moved from canonical/craft-parts#1216. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update for custom project variables (SNAPCRAFT-1053). Moved from craft-parts, approved by two reviewers, and passed CI checks. Author addressed feedback by updating entity names prior to merge. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update for custom project variables (SNAPCRAFT-1053). Transferred from canonical/craft-parts#1216. Author addressed review feedback by updating entity names prior to final merge. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-parts#1216
(confidence 99%)
Original PR from which the documentation was moved before merging in Snapcraft.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1216 docs: document custom project vars (SNAPCRAFT-1053) | craft-parts | closed | Closed unmerged after the documentation moved to Snapcraft; canonical/snapcraft#5727 merged the equivalent change in commit cba259a0d. | |
| #1625758 Missing documentation for snapcraft variables | snapcraft (launchpad) | closed | Documentation request for $SNAPCRAFT_PROJECT_NAME/VERSION/STAGE/PART_INSTALL went unanswered for years and the Launchpad bug was closed as stale. Later docs PR canonical/snapcraft#5727 (cba259a0d) covered custom project vars but did not close this bug. | |
| #757 Export important project variables | snapcraft | merged | Merged PR #757 (commit dc0b68174) exports SNAPCRAFT_PROJECT_NAME, SNAPCRAFT_PROJECT_VERSION, SNAPCRAFT_PROJECT_STAGE and per-part SNAPCRAFT_PART_INSTALL, refactoring _expand_env into the project loader so variables work in fixed yaml fields. LP #1588336. | |
| #1220 feat: support nested project variables | craft-parts | merged | Merged in canonical/craft-parts#1220 via commit fc4a3315, adding ProjectVarInfo-based nested project variables and dot-notation craftctl set commands. | |
| #3748 parts: define variables and expand them in snapcraft.yaml | snapcraft | merged | Merged PR #3748 in commit fba20a970, adding global and step-specific SNAPCRAFT_* variables for snapcraft.yaml expansion and lifecycle environments. | |
| #6464 fix(models): allow project variables in app commands | snapcraft | open | Allows well-formed ${SNAPCRAFT_*}/${CRAFT_*} project-variable references in app command fields by stripping them before snapd character validation; adds unit tests. Awaiting maintainer re-review after feedback. | |
| #5499 fix: evaluate variables in project file | snapcraft | merged | Merged in canonical/snapcraft#5499 (commit abd5db829), restoring project-variable expansion and fixing #5491 in Snapcraft 8.9.2. | |
| #1619418 parser needs to replace project level variables | snapcraft (launchpad) | closed | Parser-side substitution of SNAPCRAFT_PROJECT_NAME/VERSION landed via merged PR snapcore/snapcraft#773 (commit 362d6a5f5), closing the Launchpad bug that requested it. | |
| #5753 feat: adopt component variables | snapcraft | merged | Merged PR #5753 (SNAPCRAFT-65, SNAPCRAFT-1056) added component variables so craftctl can set component versions for core22 and core24 snaps, closing #5240. Commits: 6b6f7d9ee, 766562286. | |
| #2122 many: introduce variables for part src and build | snapcraft | merged | Merged in commit 31307b5de via #2122, adding source/build directory variables and centralizing SNAPCRAFT_* environment handling; resolved LP #1763028. |