skilld
All skills
wshobson avatar

/changelog-automation

@be57c0b
by Seth Hobsonwshobson/agents40k stars
4,281

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.

Ask your Agent

Use this Skill: https://skilld.dev/gh/wshobson/agents/changelog-automation

This session only. Nothing lands on disk.

SKILL.md

≈55 tokens always: the name and description. ≈775 when used: this file. ≈2.7k more on demand in 1 file.

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

# 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 performance
by 40%. It also includes important security updates.

## Highlights

### 🌙 Dark Mode

Users can now switch to dark mode from settings. The preference is
automatically 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

# Feature with scope
feat(auth): add OAuth2 support for Google login

# Bug fix with issue reference
fix(checkout): resolve race condition in payment processing

Closes #123

# Breaking change
feat(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 paragraphs
fix(database): handle connection timeouts gracefully

Previously, connection timeouts would cause the entire request to fail
without retry. This change implements exponential backoff with up to
3 retries before failing.

The timeout threshold has been increased from 5s to 10s based on p99
latency analysis.

Fixes #456
Reviewed-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: SKILL.md on GitHub

Third-party checks

No alerts16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    No security risks were detected. The skill provides standard documentation, templates, and configurations for automating software changelogs and release notes using well-known ecosystem tools.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at be57c0b. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 4 months ago

Topics

  • Git/VCS
  • changelog
  • conventional-commits
  • release-notes
  • semantic-versioning
  • keep-a-changelog
  • release-automation
  • version-management

README badge

README badge for wshobson/agents/changelog-automation

What it does

Automates changelog generation from git commits and releases following Keep a Changelog format and Conventional Commits conventions. Use this skill to implement standardized release workflows, generate release notes from commit history, and manage semantic versioning across projects.

Generated from the current SKILL.md.

Frequently asked

Does this skill support Conventional Commits?
Yes. The skill is built around Conventional Commits format, using commit message patterns like `feat:`, `fix:`, and `!` for breaking changes to enable automated changelog generation.
What changelog format does this skill target?
Keep a Changelog format, which organizes changes by version with sections for features, bug fixes, breaking changes, and known issues.
Can this integrate with GitHub or GitLab releases?
Yes. The skill covers generating GitHub/GitLab release notes as part of the release workflow automation.
Does this handle semantic versioning?
The skill addresses semantic versioning as part of version management, using commit types (feat, fix, breaking change) to determine version bumps.
What tools or CI systems does this skill require?
The skill documents patterns and best practices but does not specify particular tools. It assumes commitlint for validation and mentions implementing workflows in CI pipelines.

Generated from the current SKILL.md. These answers refresh after source changes.