Release Notes Generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
James Mills a1036253cd
Release the issue closes regex
2 years ago
cmd/release-notes Remove unused code 2 years ago
notes Release the issue closes regex 2 years ago
.gitignore Fix .gitignore and go.mod 2 years ago
LICENSE Initial commit 4 years ago
README.md Update README.md 2 years ago
go.mod Use PR titles as the line of text 2 years ago
go.sum Use PR titles as the line of text 2 years ago

README.md

Netdata Release Notes Generator

This repo contains a tool called release-notes and a set of library utilities at which aim to provide a simple and extensible set of tools for fetching, contextualizing, and rendering release notes for the Netdata repository.

Install

The simplest way to install the release-notes CLI is via go get:

$ go get github.com/prologic/release-notes

This will install release-notes to $GOPATH/bin/release-notes. If you're new to Go, $GOPATH default to ~/go, so look for the binary at ~/go/bin/release-notes.

Usage

To generate release notes for a commit range, run:

$ release-notes -start-sha 1be9200ba8e11dc81a2101d85a2725137d43f766 -end-sha $(git rev-parse HEAD) -github-token $GITHUB_TOKEN

Building From Source

To build the release-notes tool, check out this repo to your $GOPATH:

git clone git@github.com:prologic/release-notes.git

Run the following from the root of the repository to install dependencies:

go build ./cmd/release-notes/...

Use the -h flag for help:

./cmd/release-notes/release-notes -h

Install the binary into your path:

go install ./cmd/release-notes/...