This project is an automated release note tool and markdown history generator that transforms repository activity into structured documentation. It functions as a GitHub API client and CI/CD pipeline component, aggregating tags, issues, and pull requests to produce categorized summaries of project changes.
The tool distinguishes itself through native GitHub Enterprise integration, supporting custom API endpoints for self-hosted server instances. It employs a label-based categorization system to group changes into specific sections and utilizes personal access tokens or OAuth to manage API rate limits and access private data.
The system covers broad capabilities including content filtering, output formatting, and the preservation of historical logs. Users can define custom categories, exclude specific entries based on metadata, and manage settings through command-line arguments or local configuration files.
The tool can be executed via a command-line interface or within a Docker container.