Update Changelog

April 25, 2025 ยท View on GitHub

This command adds a new entry to the project's CHANGELOG.md file.

Usage

/add-to-changelog <version> <change_type> <message>

Where:

  • <version> is the version number (e.g., "1.1.0")
  • <change_type> is one of: "added", "changed", "deprecated", "removed", "fixed", "security"
  • <message> is the description of the change

Examples

/add-to-changelog 1.1.0 added "New markdown to BlockDoc conversion feature"

/add-to-changelog 1.0.2 fixed "Bug in HTML renderer causing incorrect output"

Description

This command will:

  1. Check if a CHANGELOG.md file exists and create one if needed
  2. Look for an existing section for the specified version
    • If found, add the new entry under the appropriate change type section
    • If not found, create a new version section with today's date
  3. Format the entry according to Keep a Changelog conventions
  4. Commit the changes if requested

The CHANGELOG follows the Keep a Changelog format and Semantic Versioning.

Implementation

The command should:

  1. Parse the arguments to extract version, change type, and message
  2. Read the existing CHANGELOG.md file if it exists
  3. If the file doesn't exist, create a new one with standard header
  4. Check if the version section already exists
  5. Add the new entry in the appropriate section
  6. Write the updated content back to the file
  7. Suggest committing the changes

Remember to update the package version in __init__.py and setup.py if this is a new version.