Key Facts
- Category
- Development
- Input Types
- textarea, select, checkbox
- Output Type
- json
- Sample Coverage
- 4
- API Ready
- Yes
Overview
The Changelog Extractor parses changelogs and release notes from formats like Keep a Changelog, Conventional Commits, and GitHub Releases. It extracts structured data including version numbers, release dates, change categories, and descriptions, outputting JSON for documentation, analysis, or automation.
When to Use
- •When you need to extract version history from changelogs for documentation or analysis.
- •When preparing release notes or migration guides by comparing software versions.
- •When automating the parsing of changelogs in CI/CD pipelines or development workflows.
How It Works
- •Input your changelog content by pasting text into the provided textarea.
- •Select the changelog format or use auto-detection to identify it automatically.
- •Configure options like including full descriptions, then extract to receive structured JSON data.
Use Cases
Examples
1. Extracting Keep a Changelog Data
- Background
- A developer maintains a project with a changelog in Keep a Changelog format and needs to automate data extraction for a website.
- Problem
- Manually updating the website with version information is tedious and prone to errors.
- How to Use
- Paste the changelog content into the input field, select 'Keep a Changelog' format, and extract the data.
- Outcome
- The tool outputs JSON with all versions, dates, and categorized changes, which can be integrated into the website's build process.
2. Analyzing GitHub Releases for Statistics
- Background
- A project manager wants to track the number of features and bug fixes over time from GitHub release notes.
- Problem
- GitHub's interface doesn't provide easy statistics on change categories across releases.
- How to Use
- Input the GitHub release notes, set format to 'GitHub Releases', and extract to get structured data.
- Outcome
- JSON data is generated with detailed statistics, such as changes per category per release, enabling trend analysis.
Try with Samples
textRelated Hubs
FAQ
What changelog formats are supported?
The tool supports Keep a Changelog, Conventional Commits, GitHub Releases, and can auto-detect the format.
Can I extract release dates from changelogs?
Yes, it extracts release dates for each version if available in the changelog.
What data is included in the JSON output?
The output includes version numbers, release dates, change categories (e.g., Added, Fixed), change descriptions, and statistics like total releases.
Is there a way to include full change descriptions?
Yes, you can enable the 'Include Full Change Descriptions' option to get complete text for each change entry.
Does the tool detect unreleased changes?
Yes, it can detect and include unreleased changes if they are present in the changelog.