changelog-action 的安装和配置教程

1. 项目基础介绍

changelog-action 是一个开源项目，主要用于自动化生成项目的更新日志（CHANGELOG）。此项目可以集成到GitHub Actions中，每当有代码提交到仓库时，自动更新项目的CHANGELOG文件。该项目主要使用TypeScript语言开发。

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

• TypeScript：一种由微软开发的开源编程语言，它是JavaScript的一个超集，添加了静态类型选项。
• GitHub Actions：GitHub提供的持续集成和持续部署服务，可以自动化您的软件开发工作流程。
• Node.js：一个基于Chrome V8引擎的JavaScript运行环境，可以让开发者使用JavaScript来编写服务器端的代码。

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

在开始安装和配置changelog-action之前，您需要确保以下准备工作已经完成：

• 您有一个GitHub账户。
• 您已经创建了一个GitHub仓库。
• 您熟悉基本的GitHub操作和命令。
• 安装了Git并且能够使用它进行基本的操作。
• 安装了Node.js和npm（Node.js的包管理器）。

安装步骤

以下是changelog-action的具体安装步骤：

1. 克隆仓库到本地

   打开终端（命令提示符或Git Bash），使用以下命令克隆项目到本地：

   git clone https://github.com/requarks/changelog-action.git
   

2. 安装依赖

   进入克隆的项目目录，使用以下命令安装项目依赖：

   cd changelog-action
   npm install
   

3. 创建GitHub Actions 工作流

   在您的GitHub仓库中，创建一个新的.github/workflows目录（如果没有的话），然后在该目录中创建一个名为changelog.yml的文件。这个文件将定义GitHub Actions的工作流程。

   文件内容示例：

   name: Update Changelog
   
   on:
     push:
       tags:
         - 'v*'
   
   jobs:
     update-changelog:
       runs-on: ubuntu-latest
       steps:
         - name: Checkout code
           uses: actions/checkout@v2
   
         - name: Set up Node.js
           uses: actions/setup-node@v2
           with:
             node-version: '14'
   
         - name: Install dependencies
           run: npm install
   
         - name: Update CHANGELOG.md
           uses: requarks/changelog-action@v1
           with:
             token: ${{ secrets.GITHUB_TOKEN }}
             changelog: CHANGELOG.md
             version: ${{ github.ref }}
   

4. 配置您的GitHub仓库

   您需要在GitHub仓库的Settings中配置Secrets，添加一个名为GITHUB_TOKEN的Secret，这样GitHub Actions才能在自动化流程中使用仓库的权限。

5. 推送到仓库

   将您的改动推送到GitHub仓库：

   git add .github/workflows/changelog.yml
   git commit -m "Add GitHub Action to update CHANGELOG"
   git push origin main
   

完成以上步骤后，每当您向仓库推送新的标签时，changelog-action将自动更新您的CHANGELOG.md文件。