Release Notes Generator

Overview

The Release Notes Generator creates polished release notes from your code reviews and ClickUp tasks. It uses AI to categorize changes, generate summaries, and format content for different audiences.

Creating Release Notes

From Date Range

1. Go to Settings → Release Notes
2. Click Create Release Notes
3. Select Date Range as source
4. Choose start and end dates
5. Enter release name and version
6. Click Generate

From Sprint/List

1. Select Sprint as source
2. Choose the ClickUp workspace
3. Select the sprint/list
4. Enter release details
5. Click Generate

From Milestone

1. Select Milestone as source
2. Choose the ClickUp workspace
3. Select the milestone/folder
4. Enter release details
5. Click Generate

Release Types

Type	Description
Major	Breaking changes, major new features (v2.0.0)
Minor	New features, backwards compatible (v1.1.0)
Patch	Bug fixes, minor improvements (v1.0.1)
Sprint	Sprint-based release notes
Custom	Custom versioning scheme

AI-Powered Features

Automatic Categorization

Changes are automatically categorized based on task names, tags, and descriptions:

• Features — New functionality
• Improvements — Enhancements to existing features
• Bug Fixes — Fixed issues
• Breaking Changes — Backwards-incompatible changes
• Deprecations — Deprecated features
• Security — Security updates

Generated Content

• Summary — High-level overview of the release
• Highlights — Key changes to emphasize
• Customer-Facing Notes — User-friendly descriptions
• Internal Notes — Technical details for developers

Editing Release Notes

Editing the Summary

Click on any section to edit the AI-generated content:

• Modify the summary and highlights
• Edit customer-facing descriptions
• Add internal notes

Managing Tickets

For each included change:

• Change Category — Recategorize if AI was wrong
• Edit Description — Customize the description
• Toggle Inclusion — Include/exclude from notes
• Mark as Highlight — Feature prominently
• Reorder — Drag to change order

Regenerating Content

Click Regenerate to re-run AI content generation while preserving your manual edits and categorizations.

Approval Workflow

Workflow States

Status	Description	Actions
Draft	Initial state, being edited	Edit, Submit for Review, Delete
Review	Pending approval	View, Approve
Approved	Ready to publish	Publish, Archive
Published	Published to channels	View, Archive
Archived	Historical record	View only

Submitting for Review

1. Complete your edits
2. Click Submit for Review
3. Release notes move to Review status

Approving Release Notes

1. Review the content
2. Click Approve
3. Release notes are ready to publish

Export Formats

Export release notes in multiple formats:

Markdown

# Release v1.2.0

## Highlights
- New authentication system
- Performance improvements

## Features
- ✨ OAuth2 support (#123)
- ✨ Dark mode theme (#124)

## Bug Fixes
- 🐛 Fixed login issue (#125)

HTML

Formatted HTML suitable for web publishing.

JSON

{
  "name": "Release v1.2.0",
  "version": "1.2.0",
  "features": [...],
  "bug_fixes": [...],
  "published_at": "2026-01-08T10:00:00Z"
}

Slack Blocks

Slack Block Kit format for posting to channels:

• Header with title and version
• Summary section
• Category sections with emoji prefixes

Publishing

Preview Before Publishing

1. Click Preview
2. Select format (Markdown, HTML, Slack, JSON)
3. Review the output

Download Export

1. Click Export
2. Select format
3. Download the file

Publishing Options

• Customer-Facing — Use customer descriptions
• Internal — Include technical details

PR Integration

Release notes automatically link to code reviews:

• PR numbers and links included
• Review verdicts captured
• Merge timestamps recorded

Best Practices

• Use consistent task naming — Helps AI categorization
• Review AI-generated content — Verify accuracy before publishing
• Mark highlights — Feature important changes prominently
• Keep customer notes user-friendly — Avoid technical jargon
• Archive old releases — Keep the list manageable