/gh2changelog

Primary LanguageGoMIT LicenseMIT

gh2changelog

Test Status MIT License PkgGoDev

gh2changelog generates keep a changelog like output from GitHub Releases

Synopsis

% gh2changelog
# Changelog

## [v0.0.14](https://github.com/Songmu/tagpr/compare/v0.0.13...v0.0.14) - 2022-08-28
- fix version file detection in releasing by @Songmu in https://github.com/Songmu/tagpr/pull/70
...

Description

The "gh2changelog" outputs a changelog of the "Keep a changelog" like format and writes it to CHANGELOG.md. To generate a changelog, it utilizes "generate-notes" in the GitHub REST API's Releases.

Options

  -all          outputs all changelogs
  -alone        only outputs the specified changelog without merging with CHANGELOG.md.
  -git string   git path (default "git")
  -latest       get latest changelog section
  -limit int    outputs the specified number of most recent changelogs
  -next string  tag to be released next
  -repo string  local repository path (default ".")
  -tag string   specify existing tag
  -unreleased   output unreleased
  -verbose      verbose
  -w            write result to CHANGELOG.md

GITHUB Token

GitHub's access token is used in the following order of priority.

  • enviroment variable GITHUB_TOKEN
  • read from gh cli configurations
  • git config github.token

Installation

# Install the latest version. (Install it into ./bin/ by default).
% curl -sfL https://raw.githubusercontent.com/Songmu/gh2changelog/main/install.sh | sh -s

# Specify installation directory ($(go env GOPATH)/bin/) and version.
% curl -sfL https://raw.githubusercontent.com/Songmu/gh2changelog/main/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]

# In alpine linux (as it does not come with curl by default)
% wget -O - -q https://raw.githubusercontent.com/Songmu/gh2changelog/main/install.sh | sh -s [vX.Y.Z]

# homebrew
% brew install Songmu/tap/gh2changelog

# go install
% go install github.com/Songmu/gh2changelog/cmd/gh2changelog@latest

# aqua https://aquaproj.github.io/
% aqua g -i Songmu/gh2changelog

Built binaries are available on gihub releases. https://github.com/Songmu/gh2changelog/releases

Author

Songmu