Skip to content
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.

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

Charm subtitle: display maintainers rather than owner? #1522

Open
sed-i opened this issue Feb 23, 2023 · 4 comments
Open

Charm subtitle: display maintainers rather than owner? #1522

sed-i opened this issue Feb 23, 2023 · 4 comments

Comments

@sed-i
Copy link
Contributor

sed-i commented Feb 23, 2023

Currently charmhub displays the owner of the charm in the subtitle:
image

Shouldn't it be a list of maintainers instead, taken from metadata?
image

Perhaps the following order of precedence makes sense?

  1. maintainers section in metadata (if present); otherwise
  2. CODEOWNERS file[gh, gl] (if present); otherwise
  3. Charm owner (fallback)

cc: @tmihoc

@Lukewh
Copy link
Contributor

Lukewh commented Mar 3, 2023

This information would need to be exposed in the store-api, I've created an issue here, for tracking https://bugs.launchpad.net/snapstore-server/+bug/2009183

Regarding changing the header, the publisher would remain the same for consistency within teams, however “maintainer” would be an additional field on the page lower down. This is partly about consistency (maintainers change and can be a long list that wouldn't fit neatly in the header), and partly about providing a stronger sense of trust for users.

@Roadmaster
Copy link

Shouldn't it be a list of maintainers instead, taken from metadata?

I don't think it should be that instead - it should always display the owner/publisher and display the maintainers if they are explicitly indicated in the metadata file.

I would not display data from CODEOWNERS directly; I don't want to bake knowledge about code provider-specific files into the store. Instead, I would advocate for charmcraft to extract data from CODEOWNERS and format/place it in the metadata file or manifest (probably manifest, since we don't modify the metadata file; the manifest is generated by charmcraft with build-time information and is somewhat analogous to snap.yaml; and remember that for snaps we do something similar where snapcraft extracts metadata from e.g. appstream xml files and puts that in the snap.yaml file).

Right now, the metadata file is exposed verbatim through the API so if there is maintainers information there, it could potentially already be displayed on the web.

curl -s 'https://api.charmhub.io/v2/charms/info/grafana-k8s?channel=edge&fields=default-release.revision.metadata-yaml' | jq '."default-release".revision."metadata-yaml"'

@tmihoc
Copy link
Member

tmihoc commented Jun 16, 2023

@Lukewh @Roadmaster any progress with this?

@Lukewh
Copy link
Contributor

Lukewh commented Jun 16, 2023

Slipped off the radar, I'll add a ticket to look into it some more next pulse :)
https://warthogs.atlassian.net/browse/WD-4630

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

No branches or pull requests

4 participants