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

document brand icons for verified actions in the marketplace #34030

Open
1 task done
jsoref opened this issue Jul 19, 2024 · 4 comments
Open
1 task done

document brand icons for verified actions in the marketplace #34030

jsoref opened this issue Jul 19, 2024 · 4 comments
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR

Comments

@jsoref
Copy link
Contributor

jsoref commented Jul 19, 2024

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/creating-actions/publishing-actions-in-github-marketplace
https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#branding

What part(s) of the article would you like to see updated?

  1. branding
    • Update introduction to briefly mention the avatar used by default and explain that you can use branding to override this avatar for actions published from user-owned repositories and for unverified actions published from organization-owned repositories.
  2. About badges in GitHub Marketplace
    • Update to explain that verified actions always display the organization avatar.
    • Mention that for other actions you can override the default icon by updating the action metadata file and link to branding

Additional information

https://docs.github.com/en/actions/creating-actions/publishing-actions-in-github-marketplace#about-badges-in-github-marketplace has pictures that show icons that are obviously not listed in https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#branding but there's nothing that explains how this works.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Jul 19, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 19, 2024
@nguyenalex836 nguyenalex836 added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jul 22, 2024
@nguyenalex836
Copy link
Contributor

@jsoref Thanks for opening an issue! I'll get this triaged for review ✨

@felicitymay
Copy link
Contributor

felicitymay commented Sep 2, 2024

Thanks for raising this interesting question. My assumption is that when an organization publishes an action, it automatically inherits the profile image for that organization (for example, Snyk and Atlassian), but that you can override this default by defining branding.

You can see that the https://github.com/marketplace/actions/snyk-node action, created by someone outside the Snyk organization uses the Feather alert-circle icon and that this is defined in the branding metadata for the action: https://github.com/awshole/snyk-node/blob/13b3b80f6e799f615fb8275464e69f04a7fa7057/action.yml#L4-L5.

In contrast, branding is undefined by this action released by the Snyk organization, see https://github.com/snyk/release-notes-preview/blob/master/action.yaml.

Before we add anything about this to the documentation, I'd like to get this confirmed by a subject matter expert.

@felicitymay felicitymay added the needs SME This proposal needs review from a subject matter expert label Sep 2, 2024
Copy link
Contributor

github-actions bot commented Sep 2, 2024

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836
Copy link
Contributor

Hi @jsoref 👋

It turns out that we were almost right:

  • The default icon is the avatar of the owner of repository associated with the action, so an organization or user avatar.
  • You can override the default icon by defining an alternate branding.
  • A verified action published by an organization has the organization's avatar, overriding any branding defined in an action.yml file.

We'll update the issue summary to suggest making the following docs changes:

  1. branding
    • Update introduction to briefly mention the avatar used by default and explain that you can use branding to override this avatar for actions published from user-owned repositories and for unverified actions published from organization-owned repositories.
  2. About badges in GitHub Marketplace
    • Update to explain that verified actions always display the organization avatar.
    • Mention that for other actions you can override the default icon by updating the action metadata file and link to branding

and add the help wanted label, so that you or anyone else may submit a PR to make these changes 💛

@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

3 participants