README.md

pull-release-notes

A command line utility to generate a PR changelog between two refs.

Usage

Install

Create local .npmrc in your project folder:

@nblagoev:registry=https://npm.pkg.github.com/

npm install @nblagoev/pull-release-notes --save-dev

This relies on the GitHub API; you should create an API token, and place it in the GITHUB_TOKEN environment variable. It needs public_repo access if your repo is public, and repo access if your repo is private.

CLI

Generate a changelog with merged pull requests between v1.0.0 and v1.1.0

pull-release-notes -v -r user/repo v1.0.0...v1.1.0 > CHANGELOG.md

In another script

import { ReleaseNotes } from "pull-release-notes"

const releaseNotes = new ReleaseNotes({
    owner: "user",
    repo: "repo-name",
    fromTag: "v1.0.0",
    toTag: "v1.1.0",
    formatter: ReleaseNotes.defaultFormatter,
})

releaseNotes.pull()
    .then(output => {
        console.log(output)
    })
    .catch(err => {
        console.error("error", err)
    })

You can also write your own formatter. See examples here.