《自动生成发布说明的项目常见问题解决方案》

《自动生成发布说明的项目常见问题解决方案》

release-notes-generator-action Action to auto generate a release note based on your events 项目地址: https://gitcode.com/gh_mirrors/re/release-notes-generator-action

一、项目基础介绍

本项目是基于GitHub Action的自动化发布说明生成器，名称为release-notes-generator-action。该项目的目的是在GitHub项目的里程碑（Milestone）关闭时，自动扫描与之关联的 Issues 和 Pull Requests，并生成一个包含这些更改的详细发布说明。主要使用的编程语言是Shell脚本和YAML，其中Shell脚本用于实际的生成过程，而YAML用于定义GitHub Action的配置。

二、新手常见问题及解决步骤

问题1：如何将此Action集成到我的GitHub项目中？

解决步骤：

1. 在你的GitHub项目根目录下创建一个新的文件夹github/workflows/。

2. 在该文件夹中创建一个新的YAML文件，例如release-notes.yml。

3. 在release-notes.yml文件中添加以下内容：

   # 触发工作流在里程碑事件上
   on: milestone:
     types: [closed]
   
   name: Milestone Closure
   
   jobs:
     create-release-notes:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@master
         - name: Create Release Notes
           uses: decathlon/release-notes-generator-action@master
   

4. 保存文件并提交到你的项目仓库。

问题2：如何自定义生成的发布说明文件名？

解决步骤：

1. 在release-notes.yml文件中的uses: decathlon/release-notes-generator-action@master步骤后添加自定义输出文件的参数。

   - name: Create Release Notes
     uses: decathlon/release-notes-generator-action@master
     with:
       output-folder: 'docs' # 指定输出文件夹
       output-name: 'CHANGELOG.md' # 指定输出文件名
   

2. 确保指定了正确的输出文件夹和文件名，然后提交更改。

问题3：生成的发布说明不包括所有相关的Issues和Pull Requests，怎么办？

解决步骤：

1. 检查是否所有的Issues和Pull Requests都已经正确关联到相应的里程碑。
2. 确认在release-notes.yml文件中使用的decathlon/release-notes-generator-action版本是最新的，因为可能已经修复了相关的bug。
3. 如果问题仍然存在，可以在GitHub上搜索相关的issue，查看是否有其他用户遇到类似问题，以及官方给出的解决方案。
4. 如果找不到解决方案，可以创建一个新的issue，提供详细的信息，包括你的GitHub项目链接、使用的Action版本号以及遇到的具体问题，请求社区帮助。

release-notes-generator-action Action to auto generate a release note based on your events 项目地址: https://gitcode.com/gh_mirrors/re/release-notes-generator-action