Skip to content

docs: clarify charm icon handling across plugins#2451

Open
gcomneno wants to merge 1 commit intocanonical:mainfrom
gcomneno:contrib/issue-2385-document-charm-icon
Open

docs: clarify charm icon handling across plugins#2451
gcomneno wants to merge 1 commit intocanonical:mainfrom
gcomneno:contrib/issue-2385-document-charm-icon

Conversation

@gcomneno
Copy link
Copy Markdown
Contributor

Summary

Add a note to the charm management docs clarifying that icon.svg handling depends on the Charmcraft plugin or profile in use.

The note calls out that modern charms in this repository typically use the uv plugin, while older charms may use dump, so the behavior is not identical in every case.

Testing

  • make -C docs html
  • make -C docs vale TARGET='docs/howto/manage-charms.md'
  • make -C docs spelling TARGET='docs/howto/manage-charms.md'

@dwilding
Copy link
Copy Markdown
Contributor

Thanks for the addition @gcomneno! Just a heads up - I won't review or merge this until I've finished #2420, which affects where we might put advice about icons.

@gcomneno
Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Collaborator

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@gcomneno
Copy link
Copy Markdown
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants