如何用gh_mirrors/re/release-action自动创建GitHub Release？5分钟快速上手教程
【免费下载链接】release-actionAn action which manages a github release项目地址: https://gitcode.com/gh_mirrors/re/release-action
gh_mirrors/re/release-action是一款强大的GitHub Action工具，能帮助开发者自动创建和管理GitHub Release，实现发布流程的自动化，节省手动操作时间。无论是上传发布 artifacts、生成发布说明，还是管理发布状态，它都能轻松搞定。
🌟 为什么选择gh_mirrors/re/release-action？
在软件开发中，发布流程往往涉及诸多重复操作，比如创建标签、编写发布说明、上传构建产物等。gh_mirrors/re/release-action的出现，正是为了解决这些痛点。它具有以下核心优势：
- 高度自动化：只需简单配置，即可在代码推送标签时自动触发发布流程。
- 灵活的 artifact 管理：支持上传单个文件、多个文件或通过通配符匹配的文件集合。
- 丰富的发布选项：可设置发布名称、描述、是否为草稿、是否为预发布等。
- 与 GitHub 生态无缝集成：利用 GitHub Actions 环境，轻松融入现有工作流。
🚀 快速开始：5分钟配置步骤
1️⃣ 准备工作
确保你的项目已托管在 GitHub 上，并且你对项目有写入权限。同时，你需要了解基本的 GitHub Actions 工作流配置方法。
2️⃣ 创建工作流文件
在你的项目根目录下，创建.github/workflows/release.yml文件（如果.github/workflows目录不存在，请先创建）。
3️⃣ 配置工作流内容
以下是一个基础的工作流配置示例，当你推送标签（如v1.0.0）时，将自动创建 Release 并上传指定的 artifacts：
name: Create Release on: push: tags: - '*' # 匹配所有标签推送事件 jobs: build-and-release: runs-on: ubuntu-latest permissions: contents: write # 授予创建 Release 的权限 steps: - name: Checkout code uses: actions/checkout@v4 # （可选）添加构建步骤，生成需要上传的 artifacts # - name: Build project # run: | # # 你的构建命令，例如 npm run build、make 等 - name: Create GitHub Release uses: https://gitcode.com/gh_mirrors/re/release-action with: artifacts: "path/to/your/artifact1.zip,path/to/your/artifact2.tar.gz" # 要上传的文件路径，多个文件用逗号分隔 bodyFile: "RELEASE_NOTES.md" # 发布说明文件路径 draft: false # 是否设为草稿发布，false 表示直接发布 prerelease: false # 是否设为预发布，false 表示正式发布4️⃣ 关键参数说明
在上述配置中，with部分是核心参数，以下是一些常用参数的说明：
| 参数名 | 描述 |
|---|---|
artifacts | 要上传到 Release 的文件路径，可使用通配符（如dist/*.zip） |
bodyFile | 包含发布说明内容的文件路径（通常是 Markdown 文件） |
draft | 是否将 Release 设为草稿（true/false） |
prerelease | 是否将 Release 标记为预发布（true/false） |
name | Release 的名称，若不指定则使用标签名 |
allowUpdates | 如果 Release 已存在，是否允许更新（true/false，默认false） |
generateReleaseNotes | 是否自动生成发布说明（true/false，默认false） |
更多详细参数可参考项目中的 action.yml 文件。
5️⃣ 推送标签触发发布
完成配置后，提交并推送工作流文件到你的仓库。然后，创建并推送一个标签：
git tag -a v1.0.0 -m "Initial stable release" git push origin v1.0.0此时，GitHub Actions 将自动触发工作流，执行release-action来创建 Release 并上传 artifacts。
💡 高级用法与最佳实践
自动生成发布说明
如果你不想手动编写发布说明，可以启用generateReleaseNotes参数，让 GitHub 自动基于提交历史生成：
with: generateReleaseNotes: true generateReleaseNotesPreviousTag: v0.9.0 # 可选，指定与哪个标签比较生成差异处理已存在的 Release
如果同名标签的 Release 已存在，默认情况下 action 会失败。你可以通过以下参数控制行为：
allowUpdates: true：允许更新已存在的 ReleaseskipIfReleaseExists: true：如果 Release 已存在，则跳过执行
管理 artifacts
removeArtifacts: true：删除已有 Release 中的所有 artifacts，再上传新的replacesArtifacts: true（默认）：替换与新上传文件同名的 artifacts
📚 常见问题解答
Q: 为什么我的 Release 没有上传 artifacts？
A: 请检查artifacts参数指定的文件路径是否正确，确保文件在工作流执行时存在（例如，确认构建步骤已成功生成文件）。
Q: 如何指定 Release 的所有者和仓库？
A: 可以通过owner和repo参数指定，默认情况下使用当前仓库。
Q: 工作流执行失败，提示权限不足怎么办？
A: 确保在工作流的permissions部分设置了contents: write权限，如示例配置所示。
🎯 总结
gh_mirrors/re/release-action 是简化 GitHub Release 管理的得力工具，通过简单的配置即可实现发布流程的自动化。无论是个人项目还是团队协作，它都能帮助你节省时间，减少手动操作带来的错误。现在就尝试将它集成到你的项目中，体验高效的自动化发布吧！
更多详细信息和高级配置，请参考项目的 README.md。
【免费下载链接】release-actionAn action which manages a github release项目地址: https://gitcode.com/gh_mirrors/re/release-action
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
