github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.44k stars 60.07k forks source link

`Publishing actions in GitHub Marketplace` should suggest repositories should be thin #35436

Open jsoref opened 5 days ago

jsoref commented 5 days ago

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/sharing-automations/creating-actions/publishing-actions-in-github-marketplace

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

https://docs.github.com/en/actions/sharing-automations/creating-actions/publishing-actions-in-github-marketplace#about-publishing-actions

When you plan to publish your action to GitHub Marketplace, you'll need to ensure that the repository only includes the metadata file, code, and files necessary for the action. Creating a single repository for the action allows you to tag, release, and package the code in a single unit. GitHub also uses the action's metadata on your GitHub Marketplace page.

This should really include advice not to have 300mb of stuff in a release (github/codeql-action currently does this and it means that anyone using the action has to wait 6 seconds for it to download).

Additional information

Repositories with large amounts of content that would have to be checked out at a specific revision and then collected into a tarball and then downloaded into a runner take much longer to retrieve making workflows slower to start.

nguyenalex836 commented 5 days ago

@jsoref Thank you for raising this issue! I'll get this triaged for review :sparkles: Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

github-actions[bot] commented 5 days ago

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