Skip to content
This repository was archived by the owner on Feb 24, 2023. It is now read-only.
eggplantsPublic archive

About

CHANGELOG.md generator specializing in github repo

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

CHANGELOG.md generator: chmd

TL;DR

Gem Codacy Badge Release Gem

  • CHANGELOG.md generator specializing in github repo

Syntax

# Changelog
<blank line>
## [<tagname>](<gh_url>/releases/tag/<tagname>) - <timestamp> ([compare](<gh_url>/compare/<prev_tagname | init_commit_hash>...<tagname>))
<blank line>
- [<commit_hash>](<gh_url>/commit/<commit_hash>)
  - <message>
- [<commit_hash>](<gh_url>/commit/<commit_hash>)
  - <message>
...
- [<commit_hash>](<gh_url>/commit/<commit_hash>)
  - <message>
<blank line>

Install

gem install chmd

Usage

  • Within git repo:
chmd

scs01

  • And output to CHANGELOG.md
chmd > CHANGELOG.md
  • Raise an error when executing outside git repo:
chmd # Error: You are not in a git repo.

License

MIT

About

CHANGELOG.md generator specializing in github repo

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages