Your first snap: Use of icon in snapcraft.yaml is deprecated
Metadata
Current evaluation
Documentation updated to replace the deprecated icon field in snapcraft.yaml with the setup/gui directory method. Tutorial corrected and verified. Issue closed.
Suggested action: —
No scores available.
Issue body
https://developer.ubuntu.com/en/snappy/build-apps/your-first-snap/
In the last example snapscraft.yaml file icon: icon.png is listed. This has now been deprecated so the tutorial needs updating.
Instead, the github docs state the following:
Snap icon
Providing an icon for your snap is important, even for command-line applications, if for nothing else than discoverability from management interfaces such as store fronts like webdm.
To use an icon to represent the snap, just drop a PNG or SVG in setup/gui named icon.png for the former or icon.svg for the latter such that the (reduced) project tree would look like:
setup/gui/icon.png
snapcraft.yaml
or
setup/gui/icon.svg
snapcraft.yaml
[Impact]
* The documentation is outdated and misleading.
* This doc will end up in developer.ubuntu.com.
[Test Case]
* N/A.
[Regression Potential]
* None, just a documentation change.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Documentation updated to replace the deprecated icon field in snapcraft.yaml with the setup/gui directory method. Tutorial corrected and verified. Issue closed. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation fixed to replace the deprecated icon field in snapcraft.yaml with the setup/gui directory method. Issue closed after verification. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #914 meta: icon is now dedeprecated | snapcraft | merged | Merged. Updates snapcraft to prioritize the icon field in snapcraft.yaml over the setup directory. Resolves LP #1610268 with minimal code changes. | |
| #1561327 icon deprecation message doesn't explain the new way | snapcraft (launchpad) | closed | Requesting clearer migration guidance for the deprecated 'icon' field in snapcraft.yaml was closed without resolution. The warning message remains unchanged, likely superseded by newer snapcraft releases. | |
| #1609568 Docs: Your First Snap Snap Icon section refers to non-existent directory | snapcraft (launchpad) | closed | Closed documentation issue noting a missing directory reference in the Your First Snap walkthrough. The inconsistency was resolved by updating the guide to explicitly include the missing setup step. | |
| #1610268 icon and license are deprecated | snapcraft (launchpad) | closed | Closed as WONTFIX. The deprecation of custom icon and license paths in snapcraft.yaml aligns with upstream snapcraft requirements. Projects must now use snapcraft's mandated directory structure. No code changes or workarounds provided. |