GitHub Release → Generate Changelog → Publish Documentation
Automatically generate release notes from GitHub commits, create formatted changelogs, and update project documentation. Streamlines the release communication process for development teams.
Workflow Steps
GitHub Actions
Trigger on new release creation
Set up a workflow that activates whenever a new release is published in your repository. Configure it to capture release tag, title, and associated commits since the last release.
GitHub CLI
Extract commits and PR data
Use GitHub CLI within the action to fetch all commits, pull requests, and their associated labels between releases. Filter for features, bug fixes, and breaking changes based on conventional commit messages or PR labels.
OpenAI GPT-4
Generate formatted changelog content
Send the commit and PR data to GPT-4 with a prompt to create a well-structured changelog. Include sections for new features, bug fixes, improvements, and breaking changes with user-friendly descriptions.
Notion
Create new changelog page
Use Notion's API to automatically create a new page in your documentation workspace with the generated changelog content, properly formatted with headers, bullet points, and links back to GitHub.
Discord
Announce release to community
Post a summary message to your Discord community channel with highlights from the release, a link to the full changelog in Notion, and download/upgrade instructions.
Workflow Flow
Step 1
GitHub Actions
Trigger on new release creation
Step 2
GitHub CLI
Extract commits and PR data
Step 3
OpenAI GPT-4
Generate formatted changelog content
Step 4
Notion
Create new changelog page
Step 5
Discord
Announce release to community
Why This Works
Leverages GitHub's native release system with AI-powered content generation and multi-platform distribution, ensuring consistent and professional release communication across all channels
Best For
Development teams and open-source projects need to communicate releases effectively to users and contributors
Explore More Recipes by Tool
Comments
No comments yet. Be the first to share your thoughts!