Publishing actions in GitHub Marketplace | Using custom Actions to publish in GitHub Marketplace | Monetize your GitHub Actions in Marketplace

{tocify} $title={Table of Contents}

You can publish actions in GitHub Marketplace and share actions you've created with the GitHub community.



Before you can publish an action, you'll need to create an action in your repository. For more information, see "Creating actions."


When you plan to publish your action to GitHub Marketplace, you'll need 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.


Actions are published to GitHub Marketplace immediately and aren't reviewed by GitHub as long as they meet these requirements:


  • The action must be in a public repository.
  • Each repository must contain a single action.
  • The action's metadata file (action.yml or action.yaml) must be in the root directory of the repository.
  • The name in the action's metadata file must be unique.
  • The name cannot match an existing action name published on GitHub Marketplace.
  • The name cannot match a user or organization on GitHub, unless the user or organization owner is publishing the action. For example, only the GitHub organization can publish an action named github.
  • The name cannot match an existing GitHub Marketplace category.
GitHub reserves the names of GitHub features.


Publishing an action

You can add the action you've created to GitHub Marketplace by tagging it as a new release and publishing it.


To draft a new release and publish the action to GitHub Marketplace, follow these instructions:

  • You can add the action you've created to GitHub Marketplace by tagging it as a new release and publishing it.


  • To draft a new release and publish the action to GitHub Marketplace, follow these instructions:


  • On GitHub.com, navigate to the main page of the repository. Navigate to the action metadata file in your repository (action.yml or action.yaml), and you'll see a banner to publish the action to GitHub Marketplace. Click Draft a release. (screenshot above)

  • Publish this action to marketplace button

  • Under "Release Action", select the checkbox to publish the action to the GitHub Marketplace. If you can't select the checkbox, you must first click the link to read and accept the GitHub Marketplace Developer Agreement.
  • Select publish to Marketplace
  • If the labels in your metadata file contain any problems, you will see an error message.
  • See notification
  • If you see any on-screen suggestions, address them by updating your metadata file. Once complete, you will see "Everything looks good!" message.

  • Choose a "Primary Category" and, optionally, "Another Category" which will help people find your action in GitHub Marketplace.
  • Choose category

  • Tag your Action with a version, and add a release title. This helps people know what changes or features the release includes. People will see the version in the action's dedicated GitHub Marketplace page.
  • Tag a version

  • Complete all other fields and click Publish release. Publishing requires you to use two-factor authentication. For more information, see "Configuring two-factor authentication."
  • Publish the release

Sample Action:

Check the Sample action i have created here: SSanjeevi/YouTubePlaylistSite: YouTube Playlist Site (github.com).

Will write an article on how to create an action from scratch in future. Thanks 😋






Reference:

Publishing actions in GitHub Marketplace - GitHub Docs

إرسال تعليق

أحدث أقدم

postad

post ad 2