Wiki Changelog

Wiki Changelog is a development skill for generating comprehensive changelogs from git history and pull requests, covering automated changelog creation, version tracking, and release documentation

What Is This?

Overview

Wiki Changelog automates the process of creating detailed changelogs by extracting information directly from your git repository history and pull request data. Instead of manually writing changelog entries, this skill analyzes commits, tags, and PR metadata to generate well-organized documentation that tracks what changed between versions. It integrates with your development workflow to produce changelogs that are always up to date and accurately reflect your project's evolution.

The skill handles the heavy lifting of changelog generation by parsing git logs, identifying version boundaries, and organizing changes into meaningful categories. It can pull PR titles, descriptions, and contributor information to create rich, contextual changelog entries that go beyond simple commit messages. Wiki Changelog also supports grouping changes by type, such as features, bug fixes, documentation updates, and breaking changes, making it easier for users and stakeholders to understand the impact of each release. By leveraging both commit and PR data, it ensures that even complex changes involving multiple contributors are documented thoroughly.

Who Should Use This

Development teams, open source maintainers, and DevOps engineers who need to generate release notes quickly and maintain accurate version history documentation without manual effort. It is especially useful for projects with frequent releases or multiple contributors, where keeping changelogs up to date can otherwise become a significant burden.

Why Use It?

Problems It Solves

Manual changelog creation is time consuming, error prone, and often gets skipped during release cycles. This skill eliminates that burden by automatically extracting relevant changes from your git history and PR data, ensuring your changelog is always accurate and comprehensive without requiring developers to remember what they changed. It also reduces the risk of missing important updates or misclassifying changes, which can lead to confusion or incomplete release notes.

Core Highlights

Automatically extracts commits and pull requests between version tags to build complete change records. Organizes changes into logical categories like features, bug fixes, breaking changes, and dependencies for better readability. Pulls contributor information and PR metadata to give proper credit and context to each change. Generates changelogs in multiple formats including markdown, JSON, and plain text for flexibility in how you publish releases. The skill can also be configured to include links to issues, PRs, or external documentation, making your changelogs more interactive and informative.

How to Use It?

Basic Usage

const changelog = await wikiChangelog.generate({
  repository: './my-project',
  fromVersion: 'v1.0.0',
  toVersion: 'v1.1.0'
});
console.log(changelog.markdown);

Real-World Examples

Generate a changelog for your latest release by comparing the current version tag with the previous one:

const release = await wikiChangelog.generate({
  repository: './my-app',
  fromTag: 'v2.3.0',
  toTag: 'v2.4.0',
  includeContributors: true
});

Create a changelog covering all changes since the last release, automatically detecting version tags:

const fullChangelog = await wikiChangelog.generate({
  repository: './my-project',
  autoDetectVersions: true,
  categories: ['features', 'fixes', 'breaking', 'docs']
});

Advanced Tips

Use commit message conventions like conventional commits to automatically categorize changes into features, fixes, and breaking changes without manual classification. Configure custom category mappings to match your team's labeling system and ensure changelogs reflect your project's specific organization structure. You can also automate changelog generation as a pre-release step in your CI/CD pipeline, ensuring every release is accompanied by up-to-date documentation.

When to Use It?

Use Cases

Automating release notes generation during your CI/CD pipeline to ensure every release has accurate, up to date documentation immediately available. Maintaining a public changelog on your project wiki or documentation site that stays synchronized with your actual releases. Generating internal release summaries for stakeholders who need to understand what shipped in each version without reading raw commit logs. Creating historical changelogs for older versions by analyzing git tags and reconstructing the change history for documentation purposes. It is also valuable for onboarding new team members, as they can quickly review the changelog to understand recent project changes.

Related Topics

This skill pairs well with semantic versioning practices, conventional commits for structured commit messages, and automated release workflows using tools like GitHub Actions or GitLab CI. It can also complement tools for automated deployment and release management.

Important Notes

Requirements

Your repository must have git history available and use consistent tagging conventions for version identification. Pull request data requires integration with your git hosting platform like GitHub, GitLab, or Bitbucket to extract PR metadata and contributor information. For best results, ensure your repository follows clear commit and PR naming conventions.

Usage Recommendations

• Use clear and consistent commit message formats, such as conventional commits, to improve automatic categorization of changes.
• Regularly tag releases in your git repository to enable accurate version boundary detection for changelog generation.
• Integrate changelog generation into your CI/CD workflow to ensure documentation is always updated with each release.
• Configure category mappings and formatting options to align changelog output with your team's documentation standards.
• Ensure your repository's pull request metadata is complete and descriptive to provide richer context in generated changelogs.

Limitations

• Does not infer changes from repositories without accessible git history or missing version tags, limiting its ability to generate accurate changelogs.
• Relies on the availability and quality of pull request data; incomplete or missing PR metadata can reduce the detail and usefulness of the changelog.
• May not fully capture changes made outside of standard git workflows, such as direct changes to production or hotfixes not associated with PRs or commits.
• Customization of output format and categories may require additional configuration for non-standard workflows or highly customized repositories.