我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

Publishing actions in GitHub Marketplace

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

GitHub 操作 is available with GitHub Free, GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. GitHub 操作 is unavailable for per-repository plans, which are legacy billing plans. For more information, see "GitHub's products."

本文内容

You must accept the terms of service to publish actions in GitHub Marketplace.

About publishing actions

Before you can publish an action, you'll need to create an action in your repository. For more information, see "Building 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 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.yml metadata file 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:

  1. On GitHub, navigate to the main page of the repository.

  2. When a repository contains an action.yml metadata file, you'll see a banner to publish the action to GitHub Marketplace. Click Draft a release.

    Publish this action to markeplace button

  3. 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.

    Select publish to Marketplace

  4. If the labels in your metadata file contain any problems, you will see an error message.

    See notification

  5. If you see any on-screen suggestions, address them by updating your metadata file. Once complete, you will see an "Everything looks good!" message.

    Fix errors

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

    Choose category

  7. 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

  8. Complete all other fields and click Publish release. Publishing requires you to use two-factor authentication. 更多信息请参阅“配置双重身份验证”。

    发布版本

Removing an action from GitHub Marketplace

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.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Releases.

    Releases tab

  3. 在发行版页面上,要编辑的发行版右侧,单击 Edit(编辑)

    发行版编辑按钮

  4. Select Publish this action to the GitHub Marketplace to remove the check from the box.

    Publish this action button

  5. Click Update release at the bottom of the page.

    Update release button

问问别人

找不到要找的内容?

联系我们