开源项目：Conventional Changelog Action 使用指南

开源项目：Conventional Changelog Action 使用指南

conventional-changelog-action Github Action that generates a changelog with the Conventional Changelog CLI 项目地址: https://gitcode.com/gh_mirrors/co/conventional-changelog-action

一、项目目录结构及介绍

开源项目conventional-changelog-action在GitHub上的仓库遵循了一套清晰的组织结构，以确保其功能的有序实现。以下是其关键目录及文件的概览：

• 根目录：

  • LICENSE: 许可证文件，表明该项目遵循MIT许可证。
  • README.md: 主要的说明文档，介绍了项目目的、基本使用方法和配置选项。
  • .gitignore: 列出了Git应当忽略的文件类型和文件夹。
  • action.yml: GitHub Actions的工作流配置文件，定义了该Action的具体行为和输入输出参数。

• src目录： 包含行动的核心逻辑代码文件，是实现自定义GitHub Action的主要部分。

• dist目录（可能在构建后生成）： 存放编译后的代码，用于部署或直接在GitHub Actions中运行。

• 其他重要文件：

  • package.json和package-lock.json: 项目依赖管理文件，定义了所需的Node.js包及其版本。
  • test目录: 包括一系列测试文件，确保代码的质量和功能正确性。
  • CHANGELOG.md: 自己项目的变更日志示例，展示本项目如何生成类似的文档。

二、项目的启动文件介绍

此项目本身作为GitHub Action运行，并不直接有一个传统意义上的“启动文件”。然而，action.yml是核心，它触发了GitHub Action的执行流程。这个YAML文件定义了以下重要部分：

• Metadata: 包括名称、描述、以及任何必要的标识信息。
• Inputs: 定义了用户可以设置的输入参数，如github-token, preset, 和其他定制化选项。
• Runs: 指定了执行环境（通常是Node.js）和入口点，通常是一个名为index.js的文件，在dist目录下经过构建过程生成。

虽然没有一个单一的“启动命令”，但在使用时，用户会在他们的GitHub工作流 YAML 文件中配置该Action，例如：

- uses: TriPSs/conventional-changelog-action@v5
  with:
    # 配置参数示例
    github-token: ${{ secrets.GITHUB_TOKEN }}
    preset: 'angular'

三、项目的配置文件介绍

动态配置

本项目主要通过输入参数进行配置（见上述“项目的启动文件介绍”）。但是，更高级或特定的配置可以通过以下几个方式实现：

• 输入参数个性化：如preset, tag-prefix, 等直接在GitHub Actions的工作流配置中指定。
• 配置文件路径 (config-file-path)：若提供，这允许用户自定义更复杂的配置，覆盖默认设定或预设值，特别是对于那些需要微调conventional commits规则的情况。配置文件应符合相应的格式要求，并且可以是相对或绝对路径，基于GITHUB_WORKSPACE.

在这个上下文中，配置并非通过单独的传统配置文件完成，而是集成到了GitHub Actions的工作流文件中或者通过指定的外部配置文件来灵活调整，满足不同项目的定制需求。这样设计使得每个使用场景都可以按需调整，保持了高度的灵活性。

conventional-changelog-action Github Action that generates a changelog with the Conventional Changelog CLI 项目地址: https://gitcode.com/gh_mirrors/co/conventional-changelog-action