Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/songmu/gh2changelog

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/songmu/gh2changelog
Owner: Songmu
License: mit
Created: 2022-08-30T13:36:04.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-10-22T09:10:51.000Z (17 days ago)
Last Synced: 2024-10-23T13:38:48.622Z (15 days ago)
Language: Go
Size: 62.5 KB
Stars: 11
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

gh2changelog
=======

[![Test Status](https://github.com/Songmu/gh2changelog/workflows/test/badge.svg?branch=main)][actions]
[![MIT License](https://img.shields.io/github/license/Songmu/gh2changelog)][license]
[![PkgGoDev](https://pkg.go.dev/badge/github.com/Songmu/gh2changelog)][PkgGoDev]

[actions]: https://github.com/Songmu/gh2changelog/actions?workflow=test
[license]: https://github.com/Songmu/gh2changelog/blob/main/LICENSE
[PkgGoDev]: https://pkg.go.dev/github.com/Songmu/gh2changelog

gh2changelog generates keep a changelog like output from GitHub Releases

## Synopsis

```console
% 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.

- https://keepachangelog.com/
- https://docs.github.com/ja/rest/releases/releases#generate-release-notes-content-for-a-release

## 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

```console
# 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.

## Author

[Songmu](https://github.com/Songmu)