You must accept the terms of service to publish actions in GitHub Marketplace.
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.yaml) must be in the root directory of the repository.
namein the action's metadata file must be unique.
namecannot match an existing action name published on GitHub Marketplace.
namecannot 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
namecannot match an existing GitHub Marketplace category.
- GitHub reserves the names of GitHub features.
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:
- When a repository contains an action metadata file (
action.yaml), you'll see a banner to publish the action to GitHub Marketplace. Click Draft a release.
- Select Publish this action to the GitHub Marketplace. If you can't select the Publish this action to the GitHub Marketplace checkbox, you'll need to read and accept the GitHub Marketplace agreement first.
- If the labels in your metadata file contain any problems, you will see an error message.
- If you see any on-screen suggestions, address them by updating your metadata file. Once complete, you will see an "Everything looks good!" message.
- Choose a "Primary Category" and, optionally, "Another Category" which will help people find your action in GitHub Marketplace.
- 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.
- Complete all other fields and click Publish release. Publishing requires you to use two-factor authentication. For more information, see "Configuring two-factor authentication."
To remove a published action from GitHub Marketplace, you'll need to update each published release. Perform the following steps for each release of the action you've published to GitHub Marketplace.
- To the right of the list of files, click Releases.
- On the Releases page, to the right of the release you want to edit, click Edit.
- Select Publish this action to the GitHub Marketplace to remove the check from the box.
- Click Update release at the bottom of the page.