Changelog CI 项目常见问题解决方案

Changelog CI 项目常见问题解决方案

changelog-ci Changelog CI is a GitHub Action that enables a project to automatically generate changelogs 项目地址: https://gitcode.com/gh_mirrors/ch/changelog-ci

项目基础介绍

Changelog CI 是一个 GitHub Action，旨在帮助开源项目自动生成变更日志（Changelog）。它能够根据 Pull Request 的标题或提交信息，自动生成变更日志，并将其添加到项目的 CHANGELOG.md 或 CHANGELOG.rst 文件中。该项目主要使用 Python 语言开发，并依赖 GitHub API 来获取和处理项目的历史数据。

新手使用注意事项及解决方案

1. 配置文件格式错误

问题描述：
新手在使用 Changelog CI 时，可能会遇到配置文件格式错误的问题，导致 Action 无法正常运行。常见的错误包括 JSON 或 YAML 格式不正确。

解决步骤：

1. 检查配置文件格式：
   确保配置文件（如 .changelogci.json 或 .changelogci.yaml）的格式正确。可以使用在线工具（如 JSONLint 或 YAMLlint）验证文件格式。

2. 参考示例配置：
   参考项目仓库中的示例配置文件，确保配置文件的结构和内容与示例一致。

3. 逐步调试：
   如果配置文件较大，可以逐步减少配置内容，逐步调试，找出导致错误的配置项。

2. 未正确触发 Action

问题描述：
新手可能会遇到 Action 未被正确触发的问题，导致变更日志未生成。常见的原因包括未正确配置 GitHub Actions 工作流文件。

解决步骤：

1. 检查工作流文件：
   确保在 .github/workflows/ 目录下有正确的工作流文件（如 changelog.yml），并且文件内容正确。

2. 确认触发事件：
   确保工作流文件中配置的触发事件（如 pull_request 或 workflow_dispatch）与实际操作一致。

3. 查看运行日志：
   进入 GitHub 仓库的 Actions 页面，查看工作流的运行日志，找出未触发的原因。

3. 生成的变更日志格式不符合预期

问题描述：
新手可能会发现生成的变更日志格式不符合预期，例如缺少某些信息或格式混乱。

解决步骤：

1. 检查配置文件：
   确保配置文件中正确设置了生成变更日志的格式和内容，例如是否包含 Pull Request 标题或提交信息。

2. 自定义模板：
   如果默认模板不符合需求，可以自定义模板文件（如 changelog_template.md），并在配置文件中指定该模板。

3. 查看生成的变更日志：
   在生成变更日志后，查看 CHANGELOG.md 或 CHANGELOG.rst 文件，确保内容和格式符合预期。

通过以上步骤，新手可以更好地理解和使用 Changelog CI 项目，避免常见问题并顺利生成变更日志。

changelog-ci Changelog CI is a GitHub Action that enables a project to automatically generate changelogs 项目地址: https://gitcode.com/gh_mirrors/ch/changelog-ci