GitHub Changelog API

An API for generating a changelog with the excellent GitHub Changelog Generator. I use it for CI/CD.

Try the Demo

Usage

Create

Changelogs can take a while to create, this starts a job.

curl -X POST github-changelog-api.herokuapp.com/:user/:repo

Retrieve

After creating a job (above), you can poll for results.

curl github-changelog-api.herokuapp.com/:user/:repo

In Progress

Continue polling until you receive a complete or error response.

Status	Payload	Headers
302	In progress...	{ Retry-After: 5 }

Complete

Save the payload data as your changelog.

Status	Payload
200	The changelog

Error

Something went wrong, consult the payload error.

Status	Payload
400	An error message

Private Repo?

Generate a token here and pass it as a query param.

curl -X POST github-changelog-api.herokuapp.com/:user/:repo?token=123

Query Params

?token=

Add a GitHub personal access token for access to private repos and a higher rate limit.

?maxIssues=

Limit the number of issues fetched. Useful for avoiding rate limits and lengthy changelog generation times.

Contribute

Setup

1. npm install
2. npm start

Dev Process

1. npm start to start the server
2. Hack on /server to change the API
3. Hack on /app to change the demo app

Credits

skywinder/github-changelog-generator