agentleFS
Sign inStart free
Data-WiseData-Wise/craft/skills/docs/changelog-automation/SKILL.md

changelog-automation

Skill4 starsChanged 13 days agoMITView on GitHub

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.

  • Installs packages

14 other projects use a version of this, 12 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use linkerd-patterns, gitops-workflow and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • xfstudioSkill

    linkerd-patterns

    Implement Linkerd service mesh patterns for lightweight, security-focused service mesh deployments. Use when setting up Linkerd, configuring traffic policies, or implementing zero-trust networking with minimal overhead.

    Also in 4 projects that use this

  • xfstudioSkill

    gitops-workflow

    Implement GitOps workflows with ArgoCD and Flux for automated, declarative Kubernetes deployments with continuous reconciliation. Use when implementing GitOps practices, automating Kubernetes deployments, or setting up declarative infrastructure management.

    Also in 4 projects that use this

  • +10 more from xfstudio

The file

We split this skill into the rules it gives an agent

1 rule. 1 is common, 0 are distinctive, and 0 are very specific to this project.

  • 1

    Common

    Most of the 14 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Don't skip validation: - Use commitlint

    line 138

“Common” is measured: kept by at least 6 in 10 of the 14 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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).

## [Unreleased]

### Added
- New feature X

## [1.2.0] - 2024-01-15

### Added
- User profile avatars
- Dark mode support

### Changed
- Improved loading performance by 40%

### Deprecated
- Old authentication API (use v2)

### Removed
- Legacy payment gateway

### Fixed
- Login timeout issue (#123)

### Security
- Updated dependencies for CVE-2024-1234

[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0

2. Conventional Commits

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
TypeDescriptionChangelog Section
featNew featureAdded
fixBug fixFixed
docsDocumentation(usually excluded)
styleFormatting(usually excluded)
refactorCode restructureChanged
perfPerformanceChanged
testTests(usually excluded)
choreMaintenance(usually excluded)
ciCI changes(usually excluded)
buildBuild system(usually excluded)
revertRevert commitRemoved

3. Semantic Versioning

MAJOR.MINOR.PATCH

MAJOR: Breaking changes (feat! or BREAKING CHANGE)
MINOR: New features (feat)
PATCH: Bug fixes (fix)

Implementation

Six methods are available depending on language and automation level. For full configuration details, see references/tool-configs.md.

MethodStackBest For
1. Conventional ChangelogNode.js (commitlint + husky)Teams enforcing commit standards at the hook level
2. standard-versionNode.jsSemver bumping + changelog in one command
3. semantic-releaseNode.js (fully automated)CI-driven releases with zero manual steps
4. GitHub ActionsYAML workflowAny stack — CI-native release pipelines
5. git-cliffRust (fast, template-based)Custom changelog formats with Tera templates
6. commitizenPythonPython projects needing interactive commit tooling

Quick start for the most common case (semantic-release in CI):

npm install -D semantic-release @semantic-release/changelog @semantic-release/git
npx semantic-release

See references/tool-configs.md for complete configs for all six methods.

Release Notes Templates

For GitHub Release and Internal Release Note templates, see references/templates-and-examples.md.

Commit Message Examples

For annotated examples covering scopes, issue references, breaking changes, and multi-paragraph bodies, see references/templates-and-examples.md.

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

Resources

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free