gh-release-note-generator

README

GitHub Release Note Generator

This is a CLI tool generating GitHub release note from GitHub Projetcs.

Usage

Usage:
  ./gh-release-note-generator -o 'organization' -r 'repository' -p 'project' -l 'label name' [flags]

Flags:
      --exclude-labels stringArray   Exclude issue labels
  -h, --help                         help for ./gh-release-note-generator
  -l, --labels stringArray           Target issue labels
  -i, --max-item-count int           Max item count in target Project (default 100)
  -o, --organization string          Organization
  -p, --project int                  Target GitHub Project ID (default 1)
  -r, --repository string            Target repository
  -t, --token string                 GitHub access token
  -v, --version                      version for ./gh-release-note-generator

The permission the GitHub Access Token should hava to access repo and read:projects.

export GITHUB_ACCESS_TOKEN="YOUR_GITHUB_ACCESS_TOKEN"

Output format

## {Label Name}
* {Issue Title} by author1, author2 in #1, #2, #3

## {Label Name}
* {Issue Title} by author in #4
* {Issue Title} by author in #5, #6

• #Number is a link of Pull Request associated with the issue.
• Output in the order of issue labels passed as arguments