Skip to content

maximousblk/ghlog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ghlog

Generate release notes based on GitHub Commits.

ghlog categorises the commits based on Conventional Commits. All the commits that don't follow the CC patern are not considered.

try it now:

deno run -A https://deno.land/x/ghlog/ghlog.ts nestdotland/nest

Install

You can install ghlog using the following command.

deno install -A https://deno.land/x/ghlog/ghlog.ts

Usage

ghlog <owner/repo> [ ...arguments ] [ ...options ]

Arguments

argument default description
[base_ref] last tag or initial commit git ref to newest commit.
[head_ref] the latest commit git ref to oldest commit.

Options

option default description
-h, --help show help
-o, --output CHANGELOG.md location to release notes output
-v, --version UNRELEASED tag to use in release notes
-d, --date current date release date
-n, --name name to use in release notes
-a, --append append to existing changelog
--auth GitHub access token to avoid rate limits

You can also use the GITHUB_TOKEN environment variable to use the GitHub access token.

Templates

ghlog provides a sane default template out of the box that works great in most situations, but if you want a more custom template, you can use the examples/ directory for reference and create your own templates.

License

This software is released under The MIT License