What This Workflow Does
This automation solves the tedious task of manually compiling GitHub release notes by leveraging AI to analyze and summarize changes between releases. It automatically compares your two most recent GitHub releases, processes all commits, pull requests, and issues, then generates professional, human-readable release notes in your preferred format.
The workflow eliminates hours of manual work while producing higher quality documentation. Development teams can focus on coding while maintaining excellent communication with stakeholders about what's changed in each release. The AI ensures consistent formatting, proper categorization of changes, and clear explanations of technical updates.
How It Works
1. GitHub Release Comparison
The workflow first identifies your two most recent GitHub releases and fetches all associated changes including commits, pull requests, and closed issues. It calculates the exact differences between these releases at the code level.
2. AI Analysis
An AI model processes all changes to understand their significance. It categorizes them into logical groups (features, fixes, improvements), identifies dependencies between changes, and determines which updates merit highlighting in the release notes.
3. Note Generation
Using your preferred template, the AI writes clear, concise release notes that explain technical changes in business-friendly language. It maintains consistent formatting, adds appropriate section headers, and can include emojis or other styling elements per your specifications.
Who This Is For
This workflow benefits development teams that:
- Release software frequently and need consistent documentation
- Want to improve communication with non-technical stakeholders
- Spend significant time manually compiling release notes
- Need to maintain audit trails of changes across versions
- Want to standardize release note formats across teams
Pro tip: Combine this with our GitHub to Slack workflow to automatically post release notes to your team channels when published.
What You'll Need
- A GitHub repository with at least two releases
- Zapier account (free plan works)
- OpenAI API key (or alternative AI service)
- Basic understanding of GitHub release workflows
Quick Setup Guide
- Download and import the JSON template into your Zapier account
- Connect your GitHub repository and OpenAI API credentials
- Configure the release comparison parameters (tag patterns, etc.)
- Customize the AI prompt to match your preferred note format
- Test with a sample release pair to verify output quality
- Schedule the workflow to run automatically after each release
Key Benefits
Time savings: Reduce release documentation time from hours to minutes while improving quality.
Consistency: Maintain uniform formatting and structure across all release notes.
Accuracy: AI cross-references code changes with commit messages for precise documentation.
Accessibility: Translates technical changes into language all stakeholders understand.
Scalability: Handles growing repositories and complex release histories with ease.