Skip to content

About

AI-powered release notes generator

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Release Notes Summarizer

A Vite + React app for generating internal release messages from ticket details, with server-side Groq requests.

What Changed

  • Groq requests now run through /api/generate so the API key stays server-side.
  • Manual version entry is now the only supported flow because the automated version lookup was unreliable in practice.
  • The previous GitHub Pages deployment flow was removed because a static-only deploy cannot safely hold the required secrets.
  • Date formatting now uses local calendar dates instead of timezone-sensitive new Date('YYYY-MM-DD') parsing.

Stack

  • React 18
  • TypeScript
  • Vite
  • Custom CSS
  • Vercel-style serverless functions in api/

Environment Variables

Create a .env file in the project root:

cp .env.example .env

Required:

GROQ_API_KEY=gsk_your_api_key_here

Local Development

Install dependencies:

npm install

Start the app:

npm run dev

vite.config.ts mounts local /api/generate middleware during development, so npm run dev exercises the same API boundary as production.

Build the frontend:

npm run build

npm run build runs a typecheck first and then bundles the production app with scripts/build.mjs, producing dist/index.html, dist/assets/app.js, and dist/assets/app.css.

Run the automated tests:

npm test

Preview the static frontend bundle:

npm run preview

npm run preview only serves the built frontend. It does not emulate the serverless API routes.

Deployment

Deploy this project to a platform that supports both:

  • static Vite output
  • server-side functions with secrets

The repo now includes vercel.json, so Vercel is the simplest deployment target.

Production secrets:

  • GROQ_API_KEY

Usage

  1. Enter version numbers manually.
  2. Choose the release date and time.
  3. Paste ticket details.
  4. Generate the release message.
  5. Review and copy the result.

About

AI-powered release notes generator

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages