Back to Details

changelog-updater

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Actualizador de Changelog

Changelog更新工具

Esta skill mantiene actualizado el archivo 
CHANGELOG.md
del proyecto de forma automática, leyendo la información directamente desde el historial de git.
本Skill可自动维护项目的
CHANGELOG.md
文件，直接从git历史记录中读取信息。

Cuándo Usar

使用时机

Usa esta skill inmediatamente después de realizar un commit exitoso. El router debería activarla automáticamente tras detectar un commit, pero también puede invocarse manualmente.
在成功完成提交后立即使用本Skill。路由应在检测到提交后自动激活它，也可手动调用。

Cómo Usar

使用方法

Ejecuta el script de actualización:
bash
python .agent/skills/changelog-updater/scripts/update_changelog.py
执行更新脚本：
bash
python .agent/skills/changelog-updater/scripts/update_changelog.py

Qué Hace el Script

脚本功能

  1. Obtiene el último commit del repositorio via 
    git log
    .
  2. Analiza el mensaje buscando el patrón de Conventional Commits (con soporte para emojis al inicio).
  3. Formatea una nueva entrada para 
    CHANGELOG.md
    incluyendo:
    • Emoji correspondiente al tipo de cambio.
    • Ámbito (scope) si existe.
    • Descripción del cambio.
    • Hash corto del commit (7 caracteres).
  4. Inserta la entrada en la sección correspondiente a la fecha actual (
    YYYY-MM-DD
    ).
  5. Si no existe 
    CHANGELOG.md
    , lo crea con la estructura base.
  1. 通过
    git log
    获取仓库的最新提交记录。
  2. 分析提交消息，识别Conventional Commits格式（支持开头带表情符号）。
  3. 为
    CHANGELOG.md
    生成新条目，包含：
    • 与变更类型对应的表情符号。
    • 变更范围（scope，若存在）。
    • 变更描述。
    • 提交的短哈希值（7位字符）。
  4. 将条目插入到对应日期（
    YYYY-MM-DD
    ）的章节中。
  5. 若
    CHANGELOG.md
    不存在，则创建基础结构的文件。

Mapeo de Emojis

表情符号映射

El script reconoce estos tipos de commit y asigna sus emojis:
TipoEmojiDescripción
feat
✨Nueva característica
fix
🐛Corrección de errores
docs
📚Documentación
style
💄Estilos y formato
refactor
♻️Refactorización de código
perf
⚡Mejoras de rendimiento
test
✅Tests
build
📦Build y dependencias
ci
👷Integración continua
chore
🔧Tareas de mantenimiento
revert
⏪Reversión de cambios
Commits que no sigan el formato Conventional Commits se registran como "Misc".
脚本可识别以下提交类型并分配对应表情符号：
类型表情描述
feat
✨新功能
fix
🐛错误修复
docs
📚文档更新
style
💄代码样式与格式调整
refactor
♻️代码重构
perf
⚡性能优化
test
✅测试相关
build
📦构建与依赖管理
ci
👷持续集成
chore
🔧维护任务
revert
⏪变更回滚
不符合Conventional Commits格式的提交将被归类为“Misc”（其他）。

Flujo de Trabajo Recomendado

推荐工作流

  1. Realiza tus cambios en el código.
  2. Haz el commit siguiendo las convenciones (usa la skill 
    commiter
    ).
  3. Ejecuta el script de esta skill.
  4. (Opcional) Si deseas que el cambio en 
    CHANGELOG.md
    forme parte del mismo commit:
    bash
    git add CHANGELOG.md
git commit --amend --no-edit
  1. 在代码中完成变更。
  2. 遵循规范提交代码（可使用
    commiter
    Skill）。
  3. 执行本Skill的脚本。 4.（可选）若希望将
    CHANGELOG.md
    的变更纳入同一提交：
    bash
    git add CHANGELOG.md
git commit --amend --no-edit

Requisitos

要求

  • Python 3 instalado.
  • Repositorio git inicializado con al menos un commit.
  • El script se ejecuta desde la raíz del proyecto.
  • 已安装Python 3。
  • git仓库已初始化，且至少有一条提交记录。
  • 需从项目根目录执行脚本。

Manejo de Errores

错误处理

  • Si no hay commits en el repo, el script muestra un mensaje informativo y no modifica nada.
  • Si 
    git
    no está disponible, el script reporta el error y termina.
  • Si el 
    CHANGELOG.md
    tiene una estructura inesperada, añade la entrada al final como fallback.
  • 若仓库中无提交记录，脚本将显示提示信息，不进行任何修改。
  • 若无法调用
    git
    ，脚本将报告错误并终止运行。
  • 若
    CHANGELOG.md
    结构不符合预期，将作为回退方案，在文件末尾添加条目。