gen-changelog

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2023 License: MIT Imports: 11 Imported by: 0

README

gen-changelog

gen-changelog is a wrapper around the GitHub CLI gh which automatically generates boilerplate for go-changelog so you can easily write the changelog body without fiddling with files and figuring out PR numbers.

Currently the "Type" options for changelogs here are inferred from hashicorp/consul's template. Feel free to fork and adjust the options as needed.

gen-changelog-demo.webm

Usage

Prerequisites

You must have gh installed and authenticated. See https://cli.github.com/ for installation instructions.

Requires go1.19 or higher.

Installing
go install github.com/kisunji/gen-changelog@latest
Usage

Currently, gen-changelog can only be run in a git repository root where it expects to find the .changelog directory.

You can optionally alias the gen-changelog to something like gcl for ease of typing.

Contributing

I consider this complete enough to use in my daily workflow, but contributions are welcome.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL