YAML变更日志生成器

用法

cargo run < changelog.yaml > CHANGELOG.md

Changelog Yaml 格式

支持的变更类型

新增功能

• 添加: 添加了新功能。 (feat)

变更

• 破坏性变更: 变更需要库的用户修改他们的代码。
• 修复: 修复了一个错误。
• 解决方案: 使用解决方案/“hack”减轻了错误或暂时绕过了错误。该解决方案通常质量较低，是短期补救措施，必须在即将发布的版本中正确修复。
• 更改: 改变了行为或代码。
• 改进: 代码被修改以获得更好的质量和稳定性。 (enhancements)
• 重构: 内部函数或代码被改进或移动，但可能对库的用户没有感知到的价值。（既不修复错误也不添加功能）
• 性能: 修改代码以提高性能。 (perf)

已删除或即将删除

• 删除: 删除了代码。它通常在之前的版本中标记为已弃用。
• 弃用: 代码已被标记为弃用。该代码将在未来的版本中删除。

其他

• 文档: 更新了文档
• 测试: 更改或添加了测试
• 实验性: 添加了代码，但不确定它是否会按预期工作，并且将来可能不会得到支持。
• 注意.（已知问题）
• 安全.（安全问题）
• 未发布: 尚未发布的变更。
• 样式: 修改代码以提高可读性和可维护性。 (style)

自动链接

拉取请求链接

#[number] 将替换为该仓库中该拉取请求的链接，例如 #1

提交哈希链接

$[hash] 将替换为该特定github哈希的链接

配置文件链接

@[GithubUsername] 将被替换为指向用户的链接，例如 @piot -> https://github.com/piot/

注意

[ADMONITION]:[space] text. 支持的注意类型

• 注意
• 重要
• 警告

示例

NOTE: This release requires latest firmware update

示例

repo: piot/nimble
repos:
  clog:
    name: CLog
    repo: piot/clog
    description: Basic logging
  secure-random-c:
    name: Secure Random
    repo: piot/secure-random-c
    description: Multi-platform Secure Random
  nimble-client-c:
    name: Nimble Client
    repo: piot/nimble-client-c
    description: Nimble Protocol Client
  nimble-server-lib:
    name: Nimble Server Library
    repo: piot/nimble-server-lib
    description: Nimble Server Library
releases:
  'v0.0.1-a06':
    date: '2023-06-22'
    notice: Minor compile fixes for emscripten.
    repos:
      clog:
        fixed:
          - use `tc_snprintf` instead of `sprintf` (#1)

      secure-random-c:
        workaround:
          - '`secureRandomUInt64()` on emscripten that only return 0'

  'v0.0.1-a05':
    date: '2023-06-14'
    notice: Hot fixes to alleviate skip ahead problems.
    repos:
      nimble-engine-client:
        changed:
          - Increase wait time between each skip ahead attempt

      nimble-server-lib:
        changed:
          - Skip increase forcedStepInRowCounter if client transport connection
            is downloading game state