将你的操作发布到 GitHub Marketplace

前言

GitHub Marketplace 是一个繁荣的生态系统，可让开发者发现、共享和使用各种操作，这些操作可以简化其工作流程、自动化任务并提高生产力。通过将操作发布到 Marketplace，你可以为社区做出贡献，同时提高你的知名度和影响力。

先决条件

在开始之前，你需要：

• GitHub 账户
• 创建好的操作（见创建自己的操作指南）
• 安装 GitHub CLI

步骤

1. 为你的操作创建存储库

首先，为你的操作创建一个新的 GitHub 存储库。这将成为你的操作的宿主。

2. 准备存储库

• 在存储库的根目录中创建 action.yml 文件。这是操作元数据的清单文件。
• 在 action.yml 中定义操作的元数据，包括名称、、输入、输出等。
• 提交更改并将存储库推送到 GitHub。

3. 创建清单文件

清单文件是 action.yml 文件，它指定操作的元数据。这是一个示例：

name: My Awesome Action
description: This action does something amazing.
runs:
  using: 'node16'
  main: 'dist/index.js'
inputs:
  some-input:
    description: 'Some input parameter.'
    required: true
outputs:
  some-output:
    description: 'Some output parameter.'

4. 安装 GitHub CLI

GitHub CLI 是一个命令行工具，可让你与 GitHub 轻松交互。使用以下命令安装它：

brew install gh

5. 将操作发布到 Marketplace

现在，你可以使用 GitHub CLI 将操作发布到 Marketplace：

gh release create v1.0.0 -d 'My awesome action' -t draft --repo 'my-org/my-action'

这将创建一个预发布版本，以便你可以对其进行审查和测试。

6. 审查和测试预发布版本

GitHub 将自动创建预发布版本的清单并将其发布到 Marketplace。你可以使用 gh 命令查看清单并测试操作：

gh release view v1.0.0 --repo 'my-org/my-action'
gh run view --repo 'my-org/my-action'

7. 发布正式版本

一旦你对预发布版本感到满意，就可以发布正式版本：

gh release edit v1.0.0 --repo 'my-org/my-action'

这将发布正式版本并将其推广到整个 Marketplace。

提示

• 使用清晰简洁的语言撰写你的操作。
• 提供明确的文档和示例代码以帮助用户使用你的操作。
• 使用标签对你的操作进行分类，以使其更容易被发现。
• 定期维护和更新你的操作。

结论

通过将操作发布到 GitHub Marketplace，你可以与更广泛的社区分享你的自动化和 DevOps 技能。通过遵循这些步骤，你可以轻松地发布你的操作并让世界看到它的价值。