Skip to content

docs: clarify charm icon handling across plugins #2451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gcomneno wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

docs: clarify charm icon handling across plugins #2451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/howto/manage-charms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ configures development tooling.
> * {external+charmcraft:ref}`Charmcraft | Manage charms > Initialize a charm <initialise-a-charm>` (see also the best practice note on setting up a repository and considering your CI)
> * [Charmcraft | Manage charms > Add charm project metadata, an icon, docs](https://canonical-charmcraft.readthedocs-hosted.com/en/latest/howto/manage-charms/#add-charm-project-metadata-an-icon-docs)

```{note}
If you want your charm to show a custom icon on Charmhub, check the Charmcraft documentation for the plugin or profile you are using. Modern charms in this repository typically use the `uv` plugin, while older charms may use `dump`, so `icon.svg` is not handled in exactly the same way in every case.
```


<!--
TODO: Add a reference link in charmcraft for the link above and the 'runtime details' one below, and switch over to external refs.
-->
Expand Down