GitHub Release Notes Generator

Generate structured release notes from your GitHub commits

\n \n

Generating release notes...

\n \n

Release Notes Preview

\n \n \n

\n\n",[18,66],"2f7f4e66-3101-11f0-b21c-569c3dd06744",["D",1747254161002],"# Frontend\n\nThis directory contains the client-side code for the GitHub Release Notes Generator.\n\n## Files\n\n- `index.html` - Main HTML template\n- `index.js` - JavaScript for the web interface\n\n## Features\n\n- Form for entering repository details and commit range\n- Preview of generated release notes in Markdown format\n- Copy to clipboard functionality\n- Download as Markdown file\n- Error handling and loading states\n\n## Dependencies\n\n- [Twind](https://twind.dev/) - Tailwind-in-JS for styling\n- [Marked](https://marked.js.org/) - Markdown parser and compiler",[18,91],"pulls","branches",1,"forks","envVars",{"_194":26,"_196":26},"connections",{"_194":26,"_195":26},"count","unfilledCount","emptyCount",{"_35":294,"_13":278,"_64":272,"_45":-5,"_37":38,"_165":282,"_166":24,"_39":295,"_41":26,"_67":93,"_168":-5,"_68":30,"_169":-5,"_220":296,"_17":297},{"_35":287,"_13":91,"_64":288,"_45":272,"_37":38,"_165":289,"_166":24,"_39":290,"_41":26,"_67":21,"_168":291,"_68":30,"_169":-5,"_220":292,"_17":293},{"_35":279,"_13":280,"_64":281,"_45":272,"_37":38,"_165":282,"_166":24,"_39":283,"_41":26,"_67":81,"_168":284,"_68":30,"_169":-5,"_220":285,"_17":286},{"_35":270,"_13":271,"_64":105,"_45":272,"_37":38,"_165":273,"_166":24,"_39":274,"_41":188,"_67":217,"_168":275,"_68":30,"_169":-5,"_220":276,"_17":277},{"_35":164,"_13":18,"_64":92,"_45":-5,"_37":38,"_165":42,"_166":24,"_39":267,"_41":26,"_67":93,"_168":-5,"_68":30,"_169":-5,"_220":268,"_17":269},{"_35":182,"_13":91,"_64":90,"_45":92,"_37":38,"_165":84,"_166":24,"_39":264,"_41":26,"_67":21,"_168":184,"_68":30,"_169":-5,"_220":265,"_17":266},{"_35":178,"_13":66,"_64":65,"_45":92,"_37":38,"_165":42,"_166":24,"_39":261,"_41":26,"_67":21,"_168":180,"_68":30,"_169":-5,"_220":262,"_17":263},{"_35":174,"_13":80,"_64":79,"_45":92,"_37":38,"_165":74,"_166":24,"_39":258,"_41":26,"_67":81,"_168":176,"_68":30,"_169":-5,"_220":259,"_17":260},{"_35":254,"_13":239,"_64":233,"_45":-5,"_37":38,"_165":243,"_166":24,"_39":255,"_41":26,"_67":93,"_168":-5,"_68":30,"_169":-5,"_220":256,"_17":257},{"_35":248,"_13":91,"_64":249,"_45":233,"_37":38,"_165":129,"_166":24,"_39":250,"_41":26,"_67":21,"_168":251,"_68":30,"_169":-5,"_220":252,"_17":253},{"_35":240,"_13":241,"_64":242,"_45":233,"_37":38,"_165":243,"_166":24,"_39":244,"_41":26,"_67":81,"_168":245,"_68":30,"_169":-5,"_220":246,"_17":247},{"_35":230,"_13":231,"_64":232,"_45":233,"_37":38,"_165":234,"_166":24,"_39":235,"_41":26,"_67":81,"_168":236,"_68":30,"_169":-5,"_220":237,"_17":238},{"_35":223,"_13":91,"_64":224,"_45":-5,"_37":38,"_165":225,"_166":24,"_39":226,"_41":26,"_67":21,"_168":227,"_68":30,"_169":-5,"_220":228,"_17":229},{"_35":211,"_13":212,"_64":213,"_45":-5,"_37":38,"_165":214,"_166":24,"_39":215,"_41":216,"_67":217,"_168":218,"_68":30,"_169":219,"_220":221,"_17":222},"864f122c-3100-11f0-a312-569c3dd06744","main.tsx","75b9adaa-3100-11f0-a312-569c3dd06744",5,["D",1747253877146],4,"http","export default async function (req: Request): Promise {\n return Response.json({ ok: true })\n}","workflows","children",[],[212],"e3898d0a-3100-11f0-bbfc-569c3dd06744","e3898db4-3100-11f0-bbfc-569c3dd06744",6,["D",1747254033564],"# GitHub Release Notes Generator\n\nThis app generates release notes based on GitHub commits. It analyzes commit messages between two points (tags, commits, or dates) and formats them into structured release notes.\n\n## Features\n\n- Fetch commits from GitHub repositories\n- Parse commit messages to categorize changes\n- Generate formatted release notes in Markdown\n- Support for conventional commit format\n- Customizable output format\n\n## Usage\n\n1. Visit the app URL\n2. Enter your repository details (owner/repo)\n3. Specify the range for commits (tags, commit hashes, or dates)\n4. Generate your release notes\n5. Copy or download the formatted output\n\n## Setup\n\nThis app requires a GitHub Personal Access Token with `repo` scope to access repository data. Set this as an environment variable in Val Town:\n\n```\nGITHUB_TOKEN=your_personal_access_token\n```\n\n## Project Structure\n\n- `backend/` - API endpoints and GitHub integration\n- `frontend/` - User interface for the app\n- `shared/` - Shared types and utilities\n\n## Technologies\n\n- TypeScript\n- GitHub REST API\n- Hono (backend framework)\n- React (frontend)\n- TailwindCSS (styling)",[],[91],"efae39e6-3100-11f0-9039-569c3dd06744","utils.ts","efae3aae-3100-11f0-9039-569c3dd06744","7be8aa0d-ec74-458a-b86d-508333b2b815",8,["D",1747254053932],"import { CommitType, COMMIT_TYPES, GitHubCommit, ReleaseNoteItem, ReleaseNoteSection } from './types';\n\n// Parse a commit message according to conventional commit format\n// https://www.conventionalcommits.org/\nexport function parseCommitMessage(commit: GitHubCommit): { type: CommitType; message: string } {\n const { message } = commit.commit;\n \n // Conventional commit format: type(scope): message\n const conventionalPattern = /^(\\w+)(?:\$([^)]+)\$)?: (.+)/;\n const match = message.match(conventionalPattern);\n \n if (match) {\n const [, type, , commitMessage] = match;\n const validType = type as CommitType;\n \n // Check if it's a known type\n if (validType in COMMIT_TYPES) {\n return { type: validType, message: commitMessage.trim() };\n }\n }\n \n // If not conventional or unknown type, use the first line of the message\n const firstLine = message.split('\\n')[0].trim();\n return { type: 'other', message: firstLine };\n}\n\n// Group commits by type for release notes\nexport function groupCommitsByType(commits: GitHubCommit[]): ReleaseNoteSection[] {\n const sections: Record = {} as Record;\n \n // Initialize sections\n Object.keys(COMMIT_TYPES).forEach(type => {\n sections[type as CommitType] = [];\n });\n \n // Group commits by type\n commits.forEach(commit => {\n const { type, message } = parseCommitMessage(commit);\n \n sections[type].push({\n message,\n author: commit.author?.login || commit.commit.author.name,\n sha: commit.sha,\n url: commit.html_url\n });\n });\n \n // Convert to array and filter out empty sections\n return Object.entries(sections)\n .filter(([, items]) => items.length > 0)\n .map(([type, items]) => ({\n title: COMMIT_TYPES[type as CommitType],\n items\n }));\n}\n\n// Generate markdown for release notes\nexport function generateMarkdown(title: string, date: string, sections: ReleaseNoteSection[]): string {\n let markdown = `# ${title}\\n\\n`;\n markdown += `*Released on ${date}*\\n\\n`;\n \n sections.forEach(section => {\n markdown += `## ${section.title}\\n\\n`;\n \n section.items.forEach(item => {\n markdown += `- ${item.message} ([${item.sha.substring(0, 7)}](${item.url})) by ${item.author}\\n`;\n });\n \n markdown += '\\n';\n });\n \n return markdown;\n}\n\n// Format date to YYYY-MM-DD\nexport function formatDate(date: Date): string {\n return date.toISOString().split('T')[0];\n}",[],[239,231],"shared","e85002ce-3100-11f0-9eff-569c3dd06744","types.ts","e8500396-3100-11f0-9eff-569c3dd06744",7,["D",1747254041572],"// Types shared between frontend and backend\n\nexport interface GitHubCommit {\n sha: string;\n commit: {\n message: string;\n author: {\n name: string;\n email: string;\n date: string;\n };\n };\n author: {\n login: string;\n avatar_url: string;\n html_url: string;\n } | null;\n html_url: string;\n}\n\nexport interface ReleaseNotesRequest {\n owner: string;\n repo: string;\n from: string; // Tag, commit hash, or date\n to: string; // Tag, commit hash, or date (optional, defaults to HEAD)\n format?: 'conventional' | 'simple'; // Commit format to parse\n}\n\nexport interface ReleaseNotesResponse {\n title: string;\n date: string;\n sections: ReleaseNoteSection[];\n rawMarkdown: string;\n}\n\nexport interface ReleaseNoteSection {\n title: string;\n items: ReleaseNoteItem[];\n}\n\nexport interface ReleaseNoteItem {\n message: string;\n author: string;\n sha: string;\n url: string;\n}\n\n// Conventional commit types\nexport const COMMIT_TYPES = {\n feat: 'Features',\n fix: 'Bug Fixes',\n docs: 'Documentation',\n style: 'Styling',\n refactor: 'Code Refactoring',\n perf: 'Performance Improvements',\n test: 'Tests',\n build: 'Builds',\n ci: 'Continuous Integration',\n chore: 'Chores',\n revert: 'Reverts',\n other: 'Other Changes'\n};\n\nexport type CommitType = keyof typeof COMMIT_TYPES;",[],[239,241],"39bdef4a-3101-11f0-a307-569c3dd06744","39bdf012-3101-11f0-a307-569c3dd06744",["D",1747254178190],"# Shared\n\nThis directory contains code shared between the frontend and backend.\n\n## Files\n\n- `types.ts` - TypeScript interfaces and types\n- `utils.ts` - Utility functions for parsing commits and generating markdown\n\n## Key Components\n\n### Types\n\n- `GitHubCommit` - GitHub API commit structure\n- `ReleaseNotesRequest` - Request format for generating release notes\n- `ReleaseNotesResponse` - Response format with generated release notes\n- `ReleaseNoteSection` - Section of categorized commits\n- `ReleaseNoteItem` - Individual commit entry in release notes\n- `COMMIT_TYPES` - Mapping of conventional commit types to human-readable titles\n\n### Utilities\n\n- `parseCommitMessage` - Parse a commit message according to conventional commit format\n- `groupCommitsByType` - Group commits by type for structured release notes\n- `generateMarkdown` - Generate markdown for release notes\n- `formatDate` - Format date to YYYY-MM-DD",[],[239,91],"e85024e8-3100-11f0-9eff-569c3dd06744",["D",1747254041572],[206,207,208],[239],["D",1747254132323],[],[18,80],["D",1747254111689],[],[18,66],["D",1747254161002],[],[18,91],["D",1747254111689],[202,203,204],[18],"20a4b8cc-3101-11f0-b4cb-569c3dd06744","index.ts","fd920574-a66a-4aa6-a24e-b0e9c65549d0",13,["D",1747254136079],"import { Hono } from 'https://esm.sh/hono@3.11.7';\nimport { cors } from 'https://esm.sh/hono@3.11.7/cors';\nimport { serveFile, readFile } from 'https://esm.town/v/std/utils@85-main/index.ts';\nimport { ReleaseNotesRequest, ReleaseNotesResponse } from '../shared/types';\nimport { formatDate, generateMarkdown, groupCommitsByType } from '../shared/utils';\nimport { GitHubClient } from './github';\n\nconst app = new Hono();\n\n// Unwrap Hono errors to see original error details\napp.onError((err, c) => {\n throw err;\n});\n\n// Enable CORS\napp.use('*', cors());\n\n// Serve static files\napp.get('/frontend/*', c => serveFile(c.req.path, import.meta.url));\napp.get('/shared/*', c => serveFile(c.req.path, import.meta.url));\n\n// Main page\napp.get('/', async c => {\n let html = await readFile('/frontend/index.html', import.meta.url);\n return c.html(html);\n});\n\n// API endpoint to generate release notes\napp.post('/api/release-notes', async c => {\n try {\n const data = await c.req.json();\n const { owner, repo, from, to = 'HEAD', format = 'conventional' } = data;\n \n // Validate input\n if (!owner || !repo || !from) {\n return c.json({ error: 'Missing required parameters' }, 400);\n }\n \n // Initialize GitHub client\n const github = new GitHubClient();\n \n // Fetch commits\n const commits = await github.getCommits(owner, repo, from, to);\n \n if (commits.length === 0) {\n return c.json({ error: 'No commits found in the specified range' }, 404);\n }\n \n // Group commits by type\n const sections = groupCommitsByType(commits);\n \n // Generate title\n const title = `Release Notes: ${owner}/${repo}`;\n const date = formatDate(new Date());\n \n // Generate markdown\n const rawMarkdown = generateMarkdown(title, date, sections);\n \n const response: ReleaseNotesResponse = {\n title,\n date,\n sections,\n rawMarkdown\n };\n \n return c.json(response);\n } catch (error) {\n console.error('Error generating release notes:', error);\n return c.json({ error: error.message }, 500);\n }\n});\n\n// Export the Hono app\nexport default app.fetch;",[],[278,271],"backend","f7401c92-3100-11f0-9f15-569c3dd06744","github.ts","f7401d5a-3100-11f0-9f15-569c3dd06744",9,["D",1747254066629],"import { GitHubCommit } from '../shared/types';\n\n// GitHub API client\nexport class GitHubClient {\n private baseUrl = 'https://api.github.com';\n private token: string;\n \n constructor() {\n const token = Deno.env.get('GITHUB_TOKEN');\n if (!token) {\n throw new Error('GITHUB_TOKEN environment variable is not set');\n }\n this.token = token;\n }\n \n private async request(path: string, options: RequestInit = {}): Promise {\n const url = `${this.baseUrl}${path}`;\n const headers = {\n 'Authorization': `token ${this.token}`,\n 'Accept': 'application/vnd.github.v3+json',\n ...options.headers\n };\n \n const response = await fetch(url, {\n ...options,\n headers\n });\n \n if (!response.ok) {\n const error = await response.text();\n throw new Error(`GitHub API error (${response.status}): ${error}`);\n }\n \n return response.json() as Promise;\n }\n \n // Get commits between two references (tags, commits, or dates)\n async getCommits(owner: string, repo: string, from: string, to: string = ''): Promise {\n let path = `/repos/${owner}/${repo}/commits?`;\n \n // Handle date format (YYYY-MM-DD)\n const datePattern = /^\\d{4}-\\d{2}-\\d{2}$/;\n \n if (datePattern.test(from)) {\n path += `since=${from}T00:00:00Z&`;\n }\n \n if (to && datePattern.test(to)) {\n path += `until=${to}T23:59:59Z&`;\n } else if (to) {\n // If 'to' is specified and not a date, use it as a reference\n path += `sha=${to}&`;\n }\n \n // If 'from' is not a date, we need to get all commits and filter\n const commits = await this.request(path);\n \n // If 'from' is a commit hash or tag, filter commits after it\n if (!datePattern.test(from)) {\n const fromCommitIndex = commits.findIndex(c => c.sha.startsWith(from));\n if (fromCommitIndex !== -1) {\n return commits.slice(0, fromCommitIndex);\n }\n }\n \n return commits;\n }\n \n // Get a specific tag reference\n async getTag(owner: string, repo: string, tag: string): Promise {\n try {\n const reference = await this.request<{ object: { sha: string } }>(`/repos/${owner}/${repo}/git/refs/tags/${tag}`);\n return reference.object.sha;\n } catch (error) {\n throw new Error(`Tag ${tag} not found: ${error.message}`);\n }\n }\n}",[],[278,280],"26de8ae2-3101-11f0-a307-569c3dd06744","26de8b8c-3101-11f0-a307-569c3dd06744",14,["D",1747254146528],"# Backend\n\nThis directory contains the server-side code for the GitHub Release Notes Generator.\n\n## Files\n\n- `index.ts` - Main entry point for the HTTP API (Hono app)\n- `github.ts` - GitHub API client for fetching repository data\n\n## API Endpoints\n\n### POST /api/release-notes\n\nGenerates release notes based on GitHub commits.\n\n**Request Body:**\n\n```json\n{\n \"owner\": \"string\", // GitHub repository owner\n \"repo\": \"string\", // GitHub repository name\n \"from\": \"string\", // Starting point (tag, commit hash, or date)\n \"to\": \"string\", // (Optional) Ending point (defaults to HEAD)\n \"format\": \"string\" // (Optional) Commit format (conventional or simple)\n}\n```\n\n**Response:**\n\n```json\n{\n \"title\": \"string\", // Release notes title\n \"date\": \"string\", // Generation date\n \"sections\": [ // Categorized sections\n {\n \"title\": \"string\", // Section title (e.g., \"Features\", \"Bug Fixes\")\n \"items\": [ // Items in this section\n {\n \"message\": \"string\", // Commit message\n \"author\": \"string\", // Author name or username\n \"sha\": \"string\", // Commit SHA\n \"url\": \"string\" // Commit URL\n }\n ]\n }\n ],\n \"rawMarkdown\": \"string\" // Formatted markdown content\n}\n```\n\n## Environment Variables\n\n- `GITHUB_TOKEN` - GitHub Personal Access Token with `repo` scope",[],[278,91],"f7402cbe-3100-11f0-9f15-569c3dd06744",["D",1747254066629],[198,199,200],[278],["D",1747253823541],{"_11":12,"_142":71},{"_11":12,"_138":-5,"_70":71,"_31":69,"_139":140,"_141":30},{"_41":129,"_13":16,"_35":38,"_130":95,"_131":-5,"_132":-5,"_133":-5,"_134":-5,"_135":-5,"_136":14,"_137":12},"ctx",{"_54":-5,"_161":335,"_336":337,"_338":339,"_340":30,"_341":30,"_342":30,"_343":24,"_344":-5,"_345":-7,"_346":-7,"_347":26,"_348":30,"_349":30,"_350":-5,"_351":30,"_352":30,"_353":30,"_354":-5},"ENV",{"_306":307,"_308":309,"_310":16,"_311":312,"_313":314,"_315":316,"_317":318,"_319":320,"_321":322,"_323":324,"_325":326,"_327":328,"_329":330,"_331":332,"_333":334},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","5a709144666c9e69e88140f015c586412f0fd8d3","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]

History · frontend