Project

chmd

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Make CHANGELOG.md from git log and tags of repository which origin exists on GitHub.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 0
 Project Readme

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