---
description: Update CHANGELOG.md with changes from the current commit
---

# Update Changelog Workflow

Update the CHANGELOG.md file with changes from the current commit.

## Steps

1. Get the current commit message:
```bash
git log -1 --pretty=format:"%s"
```

2. Get the current date in YYYY-MM-DD format:
```bash
date +%Y-%m-%d
```

3. Read the current CHANGELOG.md to understand the existing format and version

4. Determine the change type based on the commit message:
   - **Added**: New features, new files, new functionality
   - **Changed**: Changes to existing functionality
   - **Deprecated**: Features that will be removed in future versions
   - **Removed**: Features that were removed
   - **Fixed**: Bug fixes
   - **Security**: Security-related changes

5. Check if there's already an "Unreleased" section at the top:
   - If yes, add the change to the appropriate category under "Unreleased"
   - If no, create an "Unreleased" section and add the change

6. Format the changelog entry:
```markdown
## [Unreleased]

### Added
- <description of the change based on commit message>
```

7. Commit the changelog update with the same ticket prefix from the original commit:
```bash
git add CHANGELOG.md
git commit -m "<TICKET>: Update CHANGELOG.md"
```
   - Extract the ticket prefix (e.g., `COM-1773`) from the original commit message
   - Use the same ticket in the changelog commit message

## Example

For commit message: "Add eslint jquery removals only"

Add to CHANGELOG.md under `## [Unreleased]` → `### Added`:
```markdown
- ESLint configuration for jQuery v3 removals only (`jquery-v3-removals-only.js`)
```

## Notes
- Keep descriptions concise but informative
- Reference file names or features when relevant
- Group related changes together
- Follow the existing changelog style