automatic-releases 的安装和配置教程

项目基础介绍

automatic-releases 是一个开源项目，旨在帮助开源项目维护者自动化版本发布流程。该项目遵循语义化版本控制（Semantic Versioning，简称 SemVer），允许维护者通过预设的工作流自动创建和发布新版本。这个项目主要使用 YAML 语言来编写工作流配置文件，同时也涉及到一些shell脚本。

项目使用的关键技术和框架

• GitHub Actions: GitHub 提供的持续集成和持续部署（CI/CD）平台，用于自动化软件开发流程。
• GPG: 用于对发布版本进行签名的加密工具，确保版本的真实性和完整性。
• Shell Script: 用于自动化一些命令行操作。

项目安装和配置的准备工作

在开始安装和配置 automatic-releases 之前，请确保你已经具备以下条件：

1. 一个 GitHub 账号。
2. 对 GitHub Actions 有基本的了解。
3. 对 Git 和命令行操作有一定的熟悉度。
4. 一个已经创建好的 GitHub 仓库。

安装步骤

以下是详细的安装步骤：

1. 克隆示例项目

   首先，你需要将示例项目克隆到本地，以便复制工作流配置文件。

   cd /tmp
   git clone https://github.com/laminas/automatic-releases.git
   

2. 复制工作流配置文件

   接下来，将示例项目中的工作流配置文件复制到你的项目中。

   cd /path/to/your/project
   mkdir -p .github/workflows
   cp /tmp/automatic-releases/examples/.github/release-on-milestone-closed.yml .github/workflows
   

   或者，如果你想要在里程碑关闭时触发发布事件，可以使用另一个配置文件：

   cp /tmp/automatic-releases/examples/.github/release-on-milestone-closed-triggering-release-event.yml .github/workflows
   

3. 配置 Git 提交者信息

   你需要在项目中配置 Git 提交者的姓名和电子邮件地址。

   git config --local user.name "Your Name"
   git config --local user.email "[e-mail]"
   

4. 创建分支

   根据下一个里程碑版本创建一个新分支，例如，如果下一个版本是 3.2.0，则需要创建一个 3.2.x 分支。

5. 配置项目密钥

   在你的项目或组织中添加以下密钥：

   • GIT_AUTHOR_NAME: 发布者的全名。
   • GIT_AUTHOR_EMAIL: 发布者的电子邮件地址。
   • SIGNING_SECRET_KEY: 用于签名发布的密码无关的私有 GPG 密钥。
   • ORGANIZATION_ADMIN_TOKEN: 具有管理权限的 GitHub 令牌。

6. 设置仓库权限

   在目标仓库的设置中，将工作流权限设置为“读取和写入”，并勾选“允许 GitHub Actions 创建和批准拉取请求”。

7. 设置 GPG 密钥

   根据项目文档中的指导，设置 GPG 密钥并进行导出。如果你使用现有的 GPG 密钥，请创建一个用于签名的子密钥，并导出私钥和公钥。如果你生成新的 GPG 密钥，同样导出私钥和公钥。

8. 提交更改

   最后，提交你的更改到仓库中。

   git add .github/workflows
   git commit -m "添加发布自动化"
   

按照上述步骤操作，你就可以成功安装和配置 automatic-releases 项目，并开始自动化你的开源项目版本发布了。