FeaturesTemplatesShowcaseTownie
AI
BlogDocsPricing
Log inSign up
project logo

charmaine

GitHub-Release-Notes

Generate release notes directly from your GitHub commits
Public
Like
GitHub-Release-Notes
Home
Code
5
backend
3
frontend
3
shared
1
README.md
H
index.ts
Branches
3
Pull requests
Remixes
History
Environment variables
Val Town is a collaborative website to build and scale JavaScript apps.
Deploy APIs, crons, & store data – all from the browser, and deployed in milliseconds.
Sign up now
Code
/
backend
/
README.md
Code
/
backend
/
README.md
Search
5/8/2025
Viewing readonly version of main branch: v51
View latest version
README.md

Backend

This directory contains the server-side code for the GitHub Release Notes Generator.

Files

  • github.ts - GitHub API integration for fetching commits and PR data
  • llm.ts - OpenAI integration for generating release notes
  • types.ts - Type definitions for the backend

API Endpoints

POST /api/commits

Fetches commits and associated PR data from GitHub within a specified date range.

Request Body:

{ "token": "github_personal_access_token", "owner": "repository_owner", "repo": "repository_name", "startDate": "2023-01-01", "endDate": "2023-01-31" }

Response:

{ "commits": [ { "sha": "commit_sha", "message": "commit_message", "date": "commit_date", "author": "author_name", "authorUrl": "author_github_url", "commitUrl": "commit_url", "pr": { "number": 123, "title": "PR title", "description": "PR description", "url": "PR URL" } } ] }

POST /api/generate-notes

Generates user-facing release notes from commit and PR data using OpenAI.

Request Body:

{ "commits": [ // Array of commit objects from /api/commits ] }

Response:

{ "releaseNotes": { "notes": [ { "title": "Feature title", "description": "Feature description", "type": "feature", "originalCommits": ["commit_sha1", "commit_sha2"] } ], "markdown": "## Release Notes\n\n### Features\n- **Feature title**: Feature description" } }
FeaturesVersion controlCode intelligenceCLI
Use cases
TeamsAI agentsSlackGTM
ExploreDocsShowcaseTemplatesNewestTrendingAPI examplesNPM packages
PricingNewsletterBlogAboutCareersBrandhi@val.townStatus
X (Twitter)
Discord community
GitHub discussions
YouTube channel
Bluesky
Terms of usePrivacy policyAbuse contact
© 2025 Val Town, Inc.