Improve the "we recommend using charmcraft from snap" story
Metadata
Current evaluation
Closed after the CHARMCRAFT_DEVELOPER requirement was removed, eliminating the pip-install caveat that the proposed warning and documentation were meant to address.
Resolution: closed resolved
Reason: Maintainer @sergiusens closed the issue on 2022-01-26, stating: "We removed the requirement to have CHARMCRAFT_DEVELOPER set." This resolved the underlying broken-looking pip installation experience.
Evaluated by: mr-cal-bot
No scores available.
Issue body
We need to take several actions for this story to be more straightforward and users be less surprised:
- improve the project's README (which is shown both in Github and PyPI): it should declare this recommendation in a more prominent place, and inform that there are some caveats from running it as a developer, more info on the "docs page" (see next point)
- create a "doc page" (possible in the forum is enough) with several details about this recommendation:
- we recommend the snap
- on your own risk, you can run it using `CHARMCRAFT_DEVELOPER=1`
- describe the potential problems (different `charmcraft` versions outside and inside the managed environment, different Pythons used, etc)
- Point to that doc page in the error message given to the user when `charmcraft` refuses to work for this situation
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Closed after the CHARMCRAFT_DEVELOPER requirement was removed, eliminating the pip-install caveat that the proposed warning and documentation were meant to address. | |
| stealth/space-bunny-alpha | — | closed resolved | Closed after Charmcraft removed the CHARMCRAFT_DEVELOPER requirement, eliminating the pip-install caveat and proposed refusal guidance. | |
| stealth/space-bunny-alpha | — | closed resolved | Closed after Charmcraft removed the CHARMCRAFT_DEVELOPER requirement, eliminating the pip-install caveat targeted by the proposed README, documentation, and error-message updates. | |
| stealth/space-bunny-alpha | — | closed not a bug | Closed as obsolete after the CHARMCRAFT_DEVELOPER requirement was removed, so the proposed pip-install guard and messaging were no longer needed. | |
| stealth/space-bunny-alpha | — | closed not a bug | Closed by maintainer @sergiusens (2022-01-26) as obsolete: the CHARMCRAFT_DEVELOPER=1 requirement was removed, so the proposed README/doc/error-message messaging about pip-install caveats was no longer needed. | |
| stealth/space-bunny-alpha | — | closed resolved | Closed after CHARMCRAFT_DEVELOPER enforcement was removed, eliminating the pip-install caveat targeted by the proposed messaging and documentation updates. | |
| stealth/space-bunny-alpha | — | closed resolved | Removing the CHARMCRAFT_DEVELOPER requirement eliminated the need for the proposed pip-install guidance; the maintainer closed the issue as no longer applicable. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | The CHARMCRAFT_DEVELOPER environment variable requirement was removed, resolving the need for improved snap recommendation messaging and pip error handling. Closed as the underlying constraint causing user confusion no longer exists. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed after maintainers removed the CHARMCRAFT_DEVELOPER environment variable requirement. Pip installations no longer fail or require special flags, though the snap remains the recommended method. | |
| qwen/qwen3.6-35b-a3b | — | — | Resolved by removing the CHARMCRAFT_DEVELOPER environment variable requirement. The maintainers closed the issue after simplifying the charmcraft installation process, addressing the original request to improve documentation and error messaging for pip users. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | The CHARMCRAFT_DEVELOPER requirement was removed, resolving the need for improved snap recommendations and pip error messaging. The issue was closed as the underlying constraint is no longer enforced. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #396 Recommend snap in the README. | charmcraft | merged | Merged PR #396 (commit 90019231, merged as 1774741e) by maintainer facundobatista made a 3-line README edit recommending snap as the preferred install method for Charmcraft; approved by 2 reviewers. |