changelog-generator
Generate comprehensive changelogs from Git history with dual formats (client-accessible and technical) including working days calculation, feature consolidation, GitHub enrichment, and automated client-friendly translation
Security Assessment
Detected risks:
About changelog-generator
The changelog-generator skill automates the creation of comprehensive changelogs directly from Git history, addressing the challenges developers face when preparing changelogs for new releases. It integrates key Git features such as commit parsing, branch comparison, and feature consolidation, making the process of generating changelogs more efficient and accurate. Additionally, it includes the option to enrich changelog data with GitHub metadata like pull requests, issues, and contributor details, making it highly useful for teams relying on GitHub for collaboration. The skill is also designed with dual formats for output: one for non-technical clients and another for developers, ensuring accessibility for different stakeholders in the development process.
The skill's main features include working days calculation (accounting for holidays, course weeks, and weekends), feature consolidation based on temporal and scope matching, and a smart analysis of commit history to extract relevant changes. With support for GitHub authentication, users can further enhance the changelog with PR descriptions, labels, and reviewer details. It also provides AI-powered translation to turn technical descriptions into user-friendly language. Whether used for generating client changelogs or more detailed technical reports, changelog-generator streamlines the release process and improves the accuracy and clarity of changelogs across teams.
Use cases for this skill include generating changelogs for software releases, analyzing commits since the last version, and comparing branches (e.g., main vs. dev). It's targeted toward developers, team leads, and project managers who need a reliable and automated solution for changelog generation, ensuring that both technical and client-friendly documentation are consistently produced.
FAQ
How do I generate a changelog for a new version?
You can generate a changelog by running the command `go run cmd/changelog-generator/main.go generate --version <version>`, where `<version>` is the version tag you wish to generate the changelog for.
Can I specify custom branches for comparison?
Yes, you can specify custom branches by using the `--base` and `--compare` flags in the command, such as `--base main --compare feat/new-feature`.
Is GitHub authentication required?
GitHub authentication is optional but recommended for enriching your changelog with pull requests, issues, and contributor data. You can authenticate using a GitHub personal access token set via the `GITHUB_TOKEN` environment variable.
What is the working days calculation used for?
The working days calculation accounts for French holidays, course weeks, and weekends to provide an accurate estimate of the development time between commits.
What types of output formats are available?
The skill generates two changelog formats: a client-friendly version (`./changelogs/client/vX.Y.Z_client.md`) and a detailed technical version (`./changelogs/vX.Y.Z_technical.md`).
Install changelog-generator
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
kbrdn1/dotfiles