Automatically generates a changelog file from GitHub tags, issues, labels, and pull requests.
GitHub Changelog Generator is a Ruby-based command-line tool that automatically creates a changelog file for a GitHub repository. It pulls data from tags, issues, labels, and pull requests to generate a structured, markdown-formatted history of changes. This solves the problem of manually maintaining changelogs, ensuring they are accurate and up-to-date with each release.
Open-source maintainers and development teams who host their projects on GitHub and want to automate the creation and maintenance of project changelogs.
Developers choose this tool because it fully automates a repetitive task, supports extensive customization to fit project needs, integrates easily into workflows via CLI or Docker, and produces clean, standards-compliant changelogs.
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Pulls information directly from GitHub tags, issues, and pull requests to generate changelogs automatically, eliminating manual entry as described in the 'Fully automated changelog generation' section.
Supports custom sections, label mappings, and exclusions via command-line parameters and config files, detailed under 'Flexible format customization' in the README.
Works with self-hosted GitHub instances using options like --github-site and --github-api, making it versatile for internal teams, as highlighted in the 'GitHub Enterprise Support' feature.
Allows embedding images and formatted text in changelogs through GitHub issues with the 'release-summary' label, enhancing release notes with examples provided in the 'Using the summary section feature'.
Can be executed via CLI, Docker, or Rake tasks, facilitating easy adoption into various development and deployment workflows, including CI/CD pipelines as shown in the 'Practical Use Cases'.
Requires Ruby to be installed, which can be a hurdle for non-Ruby projects or in containerized environments without Ruby pre-installed, as noted in the 'Installation' section and FAQ for old Ruby versions.
Subject to GitHub's API rate limits; without a personal access token, usage is restricted to 50 unauthenticated requests per hour, forcing token management as warned in the 'GitHub token' section.
Does not run automatically; changelogs must be generated manually or scripted, which can lead to missed updates if not integrated into release processes, unlike real-time solutions.
Exclusively designed for GitHub's API and features, making it unsuitable for projects on other Git hosting services without significant modifications, as admitted in the 'Alternatives' wiki page reference.