Changelog Automation

by wshobson46891e7e60daNo licenseListed Oct 8, 2026Updated Oct 8, 2026

Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.

Instructions onlyDevOps & Cloud Software Development

AI-generated overview

Guides automated changelog and release-note generation from commits, PRs, and releases using Keep a Changelog and Conventional Commits.

What it does: This skill provides patterns and conventions for automating changelog generation, release notes, and version management. It documents the Keep a Changelog format, Conventional Commits message examples, and best practices for standardizing commit conventions and semantic versioning. It also points to a reference file with detailed patterns and worked examples. It produces guidance and templates rather than running code.
When to use it: Use it when setting up release workflows, generating release notes, or standardizing commit message conventions. It suits teams adopting Conventional Commits, semantic versioning, or automated GitHub and GitLab release notes.
Requirements: No scripts or tools are required; it is instructions and reference documentation only. Reading the bundled reference file is optional.

Changelog Automation

Patterns and tools for automating changelog generation, release notes, and version management following industry standards.

When to Use This Skill

Setting up automated changelog generation
Implementing Conventional Commits
Creating release note workflows
Standardizing commit message formats
Generating GitHub/GitLab release notes
Managing semantic versioning

Core Concepts

1. Keep a Changelog Format

markdown

# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Detailed patterns and worked examples
Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
## Summary
This release introduces dark mode support and improves checkout performanceby 40%. It also includes important security updates.
## Highlights
### 🌙 Dark Mode
Users can now switch to dark mode from settings. The preference isautomatically saved and synced across devices.
### ⚡ Performance
- Checkout flow is 40% faster- Reduced bundle size by 15%
## Breaking Changes
None in this release.
## Upgrade Guide
No special steps required. Standard deployment process applies.
## Known Issues
- Dark mode may flicker on initial load (fix scheduled for v2.1.1)
## Dependencies Updated
| Package | From    | To      | Reason                   || ------- | ------- | ------- | ------------------------ || react   | 18.2.0  | 18.3.0  | Performance improvements || lodash  | 4.17.20 | 4.17.21 | Security patch           |

# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Detailed patterns and worked examples
Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
## Summary
This release introduces dark mode support and improves checkout performanceby 40%. It also includes important security updates.
## Highlights
### 🌙 Dark Mode
Users can now switch to dark mode from settings. The preference isautomatically saved and synced across devices.
### ⚡ Performance
- Checkout flow is 40% faster- Reduced bundle size by 15%
## Breaking Changes
None in this release.
## Upgrade Guide
No special steps required. Standard deployment process applies.
## Known Issues
- Dark mode may flicker on initial load (fix scheduled for v2.1.1)
## Dependencies Updated
| Package | From    | To      | Reason                   || ------- | ------- | ------- | ------------------------ || react   | 18.2.0  | 18.3.0  | Performance improvements || lodash  | 4.17.20 | 4.17.21 | Security patch           |

Commit Message Examples

bash

# Feature with scopefeat(auth): add OAuth2 support for Google login
# Bug fix with issue referencefix(checkout): resolve race condition in payment processing
Closes #123
# Breaking changefeat(api)!: change user endpoint response format
BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.Migration guide: Update all API consumers to use the new field name.
# Multiple paragraphsfix(database): handle connection timeouts gracefully
Previously, connection timeouts would cause the entire request to failwithout retry. This change implements exponential backoff with up to3 retries before failing.
The timeout threshold has been increased from 5s to 10s based on p99latency analysis.
Fixes #456Reviewed-by: @alice

# Feature with scopefeat(auth): add OAuth2 support for Google login
# Bug fix with issue referencefix(checkout): resolve race condition in payment processing
Closes #123
# Breaking changefeat(api)!: change user endpoint response format
BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.Migration guide: Update all API consumers to use the new field name.
# Multiple paragraphsfix(database): handle connection timeouts gracefully
Previously, connection timeouts would cause the entire request to failwithout retry. This change implements exponential backoff with up to3 retries before failing.
The timeout threshold has been increased from 5s to 10s based on p99latency analysis.
Fixes #456Reviewed-by: @alice

Best Practices

Do's

Follow Conventional Commits - Enables automation
Write clear messages - Future you will thank you
Reference issues - Link commits to tickets
Use scopes consistently - Define team conventions
Automate releases - Reduce manual errors

Don'ts

Don't mix changes - One logical change per commit
Don't skip validation - Use commitlint
Don't manual edit - Generated changelogs only
Don't forget breaking changes - Mark with ! or footer
Don't ignore CI - Validate commits in pipeline

Source and attribution

Source:wshobson/agentsinplugins/documentation-generation/skills/changelog-automationat commit46891e7

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Changelog Automation

Changelog Automation

When to Use This Skill

Core Concepts

1. Keep a Changelog Format

Commit Message Examples

Best Practices

Do's

Don'ts

Source and attribution

More from wshobson/agents

Uv Package Manager

Web Component Design

Python Type Safety

Visual Design Foundations

Responsive Design

Python Resource Management

More in DevOps & Cloud

M5 Onboard

Spanner Basics

Secops Cases

Managed Airflow Migrations

Managed Airflow Dag Troubleshooting

Iam Helper For Privileged Access Management