Release Changelog Builder Action 使用教程

Release Changelog Builder Action 使用教程

release-changelog-builder-action A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want. 项目地址: https://gitcode.com/gh_mirrors/re/release-changelog-builder-action

1. 项目的目录结构及介绍

release-changelog-builder-action/
├── .github/
│   └── workflows/
│       └── example.yml
├── src/
│   ├── main.ts
│   └── utils/
│       └── changelog.ts
├── .gitignore
├── action.yml
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• .github/workflows/: 包含GitHub Actions的工作流配置文件，例如example.yml。
• src/: 项目的源代码目录，包含主要的TypeScript文件。
  • main.ts: 项目的主入口文件。
  • utils/: 包含一些工具函数，例如changelog.ts用于生成变更日志。
• .gitignore: 指定Git忽略的文件和目录。
• action.yml: GitHub Action的配置文件，定义了Action的输入、输出和运行环境。
• package.json: 项目的依赖管理文件，包含项目的依赖和脚本。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

src/main.ts

main.ts是项目的启动文件，负责初始化并执行生成变更日志的主要逻辑。以下是该文件的主要功能：

• 初始化配置: 读取GitHub Action的输入配置。
• 生成变更日志: 根据配置生成项目的变更日志。
• 输出结果: 将生成的变更日志输出到指定的位置。

3. 项目的配置文件介绍

action.yml

action.yml是GitHub Action的配置文件，定义了Action的输入、输出和运行环境。以下是该文件的主要内容：

name: 'Release Changelog Builder'
description: 'A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.'
inputs:
  configurationJson:
    description: 'JSON configuration for the changelog builder'
    required: false
    default: '{}'
outputs:
  changelog:
    description: 'The generated changelog'
runs:
  using: 'node16'
  main: 'dist/index.js'

配置项介绍

• name: Action的名称。
• description: Action的描述。
• inputs: 定义了Action的输入参数。
  • configurationJson: 用于配置变更日志生成的JSON字符串。
• outputs: 定义了Action的输出结果。
  • changelog: 生成的变更日志内容。
• runs: 定义了Action的运行环境及主入口文件。
  • using: 使用的运行环境，这里是node16。
  • main: 主入口文件的路径，这里是dist/index.js。

通过以上配置，用户可以根据自己的需求自定义变更日志的生成方式。

release-changelog-builder-action A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want. 项目地址: https://gitcode.com/gh_mirrors/re/release-changelog-builder-action