A GitLab CI/CD tool that automatically generates structured release notes from merged merge requests and closed issues.
GitLab Release Note Generator is an open-source tool that automatically creates release notes for GitLab projects. It scans tags, merged merge requests, and closed issues within a release timeframe, then generates a structured changelog categorized by labels like enhancements, bugs, and breaking changes. It solves the problem of manual, error-prone release documentation.
GitLab users, DevOps engineers, and development teams who manage releases through GitLab and want to automate their changelog generation as part of CI/CD pipelines.
Developers choose this tool because it integrates seamlessly with GitLab CI, requires minimal configuration, and produces consistent, well-organized release notes without manual intervention. Its label-based categorization and support for custom GitLab instances offer flexibility over generic solutions.
A Gitlab release note generator
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Designed to run automatically in GitLab CI pipelines, triggered by tag pushes, with a provided sample .gitlab-ci.yml file for easy setup, as shown in the Gitlab CI method section.
Supports deployment as a containerized service with clear Docker commands in the README, allowing easy execution in any environment without Node.js dependencies.
Offers flexible customization through environment variables like GITLAB_API_ENDPOINT for self-hosted instances and TARGET_TAG_REGEX for branch-specific tagging, detailed in the options section.
Automatically groups merge requests and issues by labels such as enhancement, breaking change, feature, and bug for structured changelogs, as explained in the feature list and how it works.
The TODO list admits that customizing the release note template is a missing feature, limiting control over output formatting and styling.
Only works with GitLab, making it unsuitable for projects hosted on other platforms like GitHub, which is a fundamental limitation not addressed in the README.
Relies heavily on specific labels for categorization, and items with multiple labels are duplicated in output, potentially cluttering notes if labels are not managed carefully, as noted in the feature description.