Skip to content

fix: store listing improvements - #16

Merged
astrojuanlu merged 5 commits into
mainfrom
listing-improvements
Oct 22, 2026
Merged

astrojuanlu merged 5 commits into
mainfrom
listing-improvements

Conversation

@astrojuanlu

Copy link
Copy Markdown
Contributor

What

Three listing-quality fixes found reviewing the store page:

  1. No description wordwrap - wordwrap(76) produced ragged
    mid-sentence hard breaks (e.g. 'a filter that⏎provides'). The YAML
    now keeps paragraphs unwrapped; the store soft-wraps for display.
  2. 'Report a bug' lands on the tracker - contact:/issues:
    previously rendered the repo root; now .../issues. (Verified: the
    store page links exactly the issues URL.)
  3. icon: meta/gui/icon.png - declared in the yaml; the file is
    materialized at pack time by the pack workflow (obs-plugins-snaps
    workflows PR fix: persist the upstream pin in answers as source_tag #11: org avatar default, repo-shipped override). The
    icon propagates to the store listing via the uploaded snap.

Verified

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi

@astrojuanlu

Copy link
Copy Markdown
Contributor Author

Amended (763d48a): the template now ships the icon at template/snap/meta/gui/icon.png (the org avatar, 256px target - current upstream PNG is 152x152, within the 40-512 range and <256KB).

Why: icon: in snapcraft.yaml must reference a file packaged into the snap - the schema does not accept URLs (a 2019 PR to allow http(s) URLs was never merged). So 'fallback to an absolute URL' is impossible; shipping the asset in the template is the right shape, as you suspected.

Override path: a repo replaces snap/meta/gui/icon.png with its own file (hand-owned afterwards, like the pin). The pack-time org-avatar fetch in workflows PR #11 stays as a belt-and-braces fallback for repos whose answers predate this file.

Render-verified: fresh copier copy emits snap/meta/gui/icon.png (valid PNG) + icon: meta/gui/icon.png in snapcraft.yaml.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi

@astrojuanlu

Copy link
Copy Markdown
Contributor Author

Flattened (c7ad061): the icon now lives at snap/gui/icon.png and the yaml renders icon: snap/gui/icon.png.

Why it's fine: meta/gui/ is only the in-snap install layout that snapcraft generates at pack time (it copies whatever icon: points at); the yaml key accepts any path relative to the source tree root. The old path was over-nested for a repo; snap/gui/ keeps the asset inside the existing snap/ directory. Render-verified: fresh copier copy emits snap/gui/icon.png + correct key.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi

The 76-column wordwrap produced ragged mid-sentence breaks in the
rendered snapcraft.yaml and the store listing; the store soft-wraps
text for display anyway.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi
The store's 'Report a bug' link is the issues URL verbatim; it pointed
at the repository root instead of .../issues.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi
icon: must reference a file packaged into the snap (the schema does not
accept URLs), so the org avatar is shipped at snap/gui/icon.png and
rendered as icon: snap/gui/icon.png. Repos may replace the file with
their own (hand-owned afterwards). The pack-time fetch in workflows
becomes a fallback for repos predating this file.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi
[![<snap>](https://snapcraft.io/<snap>/badge.svg)](https://snapcraft.io/<snap>)

directly under the title, so freshly bootstrapped repos show the store
status from day one.

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi
- contact/issues now point at the packaging repo's issue tracker
- multi-paragraph descriptions are no longer hard-wrapped (the store
  soft-wraps for display); assert paragraphs survive unwrapped
- new tests: the rendered yaml declares icon: snap/gui/icon.png with a
  valid PNG shipped at that path, and the README carries the store
  badge

Assisted-by: OpenRouter:z-ai/glm-5.3-flash pi
@astrojuanlu
astrojuanlu merged commit 6ddf919 into main Oct 22, 2026
1 check passed
@astrojuanlu
astrojuanlu deleted the listing-improvements branch October 22, 2026 19:02
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.

1 participant