release-drafter/release-drafter
Release Drafter
Release-drafter is a GitHub Action workflow and automation engine designed to manage the software release lifecycle. It functions as a release notes automator, an automated changelog generator, and a semantic versioning calculator that aggregates merged pull requests into structured draft releases.
The project distinguishes itself through event-driven execution that triggers updates based on repository activity. It features a semantic versioning calculator to determine the next version number based on merged change categories, and provides specialized management for both stable and prerelease draft notes.
The tool covers a broad range of automation capabilities, including rule-based change categorization, pattern-based labeling for issues and pull requests, and template-driven content rendering. It also supports changelog customization through regular expression text transformations and contributor list filtering.
Features
- GitHub Release Automators - Provides an automation engine that aggregates merged pull requests into structured draft releases and changelogs specifically for GitHub.
- Release Note Generation - Aggregates merged pull requests into structured draft releases and maintains automated release notes on GitHub.
- Event-Driven Workflow Triggers - Provides automated triggers that initiate release note updates based on GitHub pull request merge events.
- Label-Based Categorization - Groups merged pull requests into distinct changelog sections based on label matches or file path patterns.
- Release Changelog Generators - Uses templates and regular expressions to automatically format release summaries from pull request metadata.
- Version Calculators - Calculates the next project version number by combining merged change categories with semantic versioning rules.
- GitHub Actions Workflows - Automates repository tasks like labeling and release note updates using GitHub Actions workflows.
- Automated Version Incrementing - Programmatically calculates the next version number based on categories and labels of merged changes.
- Draft Release Creators - Manages the transition from merged code to public release by creating automated draft releases and tracking versions.
- Version Calculation Logic - Determines the next project version number by mapping change categories to semantic versioning increment rules.
- Change Type Categorizations - Organizes the changelog by grouping merged pull requests into specific sections based on labels or file paths.
- Changelog Renderers - Applies custom templates and regular expressions to format release names, tags, and pull request content.
- Layout Templates - Provides templates and variables to define the visual layout of release headers, footers, and category titles.
- Pull Request Labelers - Automatically assigns labels to pull requests by matching file patterns, branch names, or text content.
- Changelog Content Renderers - Generates structured changelogs by injecting aggregated pull request data into customizable layout templates.
- Post-Processing Text Transformations - Modifies the final generated changelog body using regular expression search-and-replace operations.
- Regex Text Transformations - Sanitizes and refines generated release notes using regular expression search-and-replace patterns.
- Prerelease Managers - Manages the lifecycle and versioning identifiers of prerelease drafts to track changes between unstable versions.
- रिलीज़ कॉन्ट्रिब्यूशन फिल्टर्स - Includes or excludes specific pull requests from release notes based on defined matching criteria and rules.
