docs: clarify charm icon handling across plugins#2451
docs: clarify charm icon handling across plugins#2451gcomneno wants to merge 1 commit intocanonical:mainfrom
Conversation
|
Thanks for the heads up! That makes sense. I’ll leave this as-is for now and wait for #2420 to settle before making any further changes. |
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
This is also not quite correct. If you're using uv for the charm plugin, then you need to use the dump plugin to include the icon file. I think that is the case for poetry and python too, but I'm not 100% sure on that. I think the old charm plugin is the only one that pulls in the icon by default.
I think we would also want to have an example of what the YAML would look like to add the icon.
|
Thanks Tony, that's helpful. I agree the current wording is too broad. I'll hold off on revising this until #2420 settles where this advice should live, but the next version should distinguish the old charm plugin from uv/poetry/python-based projects and include a concrete YAML example using the dump plugin to include the icon file. |
Summary
Add a note to the charm management docs clarifying that
icon.svghandling depends on the Charmcraft plugin or profile in use.The note calls out that modern charms in this repository typically use the
uvplugin, while older charms may usedump, so the behavior is not identical in every case.Testing
make -C docs htmlmake -C docs vale TARGET='docs/howto/manage-charms.md'make -C docs spelling TARGET='docs/howto/manage-charms.md'