zircote

Release Notes Generation Prompt - zircote Brand

Use this prompt to generate release announcements for open source tools.

Template Variables

Generation Prompt

You are writing a release announcement blog post for  v
for zircote.com.

PROJECT: 
VERSION: 
RELEASE TYPE: 

CHANGELOG:


BREAKING CHANGES:


KEY HIGHLIGHTS:


REQUIREMENTS:

1. FRONTMATTER:
   ---
   layout: post
   title: " v: [Key Feature]"
   date: YYYY-MM-DD
   categories: [releases, ]
   tags: [, release, ]
   excerpt: " v is now available with [key highlights]."
   comments: true
   ---

2. STRUCTURE:
   - **Opening**: What's new in one sentence
   - **Highlights**: 2-3 key features with brief explanations
   - **Breaking Changes** (if any): Clear migration instructions
   - **Full Changelog**: Categorized list (Features, Fixes, etc.)
   - **Installation/Upgrade**: How to get the new version
   - **What's Next**: Brief roadmap mention
   - **Thanks**: Acknowledge contributors

3. FORMATTING:
   - Use > [!WARNING] for breaking changes
   - Use code blocks for installation commands
   - Link to GitHub release, docs, and PRs
   - Keep it scannable (bullets, headers)

4. TONE:
   - Excited but professional
   - Focus on user benefits
   - Be specific about what changed

Generate the complete release announcement now.

Example Output Structure

---
layout: post
title: "git-adr v2.0.0: Semantic Search for Your Architecture Decisions"
date: 2025-01-15
categories: [releases, git-adr]
tags: [git-adr, release, adr, search, semantic]
excerpt: "git-adr v2.0.0 brings natural language search, making it easier than ever to find relevant architecture decisions."
comments: true
---

git-adr v2.0.0 is now available, bringing semantic search capabilities
to your architecture decision records.

## Highlights

### Natural Language Search
...

### Performance Improvements
...

## Breaking Changes

> [!WARNING]
> The `--format` flag has been renamed to `--output`.

**Migration:**
```bash
# Before
git adr list --format json

# After
git adr list --output json

Full Changelog

Features

Bug Fixes

Installation

# Homebrew
brew upgrade git-adr

# pip
pip install --upgrade git-adr

What’s Next

…

Contributors

Thanks to @contributor1, @contributor2 for their contributions!

Full release notes on GitHub ```