stvnwrgs / asdf

Changelog generation as easy as typing asdf

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

asdf

Generates a changelog based on semantic commit messages.

Usage

$ asdf --help
NAME:
   asdf - Changelog and version generation based on semantic commit messages.

   Specification about the structure is here: http://conventionalcommits.org
   All commit messages should follow this very convention:
   -------------------------------
   <type>(scope): <subject>

   <body>
   -------------------------------

   Example commit message subjects:

   feat(TICKET-123): implementing a feature
   fix: fixed something
   (TICKET-123): some message



USAGE:
   asdf [global options] command [command options] [arguments...]

VERSION:
   0.1.0

COMMANDS:
     next-version, n  Tells you the next version you want to release. By default it uses a VERSION file to fetch the history since the last release. the file location may be overridden via --file
     generate, g      generates a changelog and the next version based on semantic commits and writes them to files
     changelog, c     generates the changelog and writes it to stdout. By default it uses a VERSION file to fetch the history since the last release. This can be overridden by defining a--version and --revision
     help, h          Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --dir value    set the current wokring directory
   --help, -h     show help
   --version, -v  print the version

Commit Message Schema

Commit messages have to follow the angularjs commit message conventions [link].

Examples

  • test(PROJ-1312): write tests. do yourself a favor
  • docs(PROJ-1000):some thing!
  • (TICKK-123): foobar booman
  • bug: Y U NO GOAT?

Resulting Markdown

## 0.2.0 (2017-11-14)

#### 

* * WIP: generate tests (8835f264) 

#### Documentation

* display usage (d2bd0903) 

#### Feature

* next command (e6beb561) 
* parsing commit body (6c0eed43) 

#### Bug Fixes

* changelog test depended on time oo (ac4b9d06) 
* parsing multi-line commits (9c1b0bea) 

#### Code Refactoring

* removing asdf.json (eb481d20) 
* changelog cmd (c80c64e5) 
* getting rid of type constraints (78361cc1) 
* cmd now in repo root (94e034d4) 

#### Tests

* config (ddf8535f) 
* cli commands (dcd068a0) 

default types

Key Label Change type
breaking Breaking Changes Major
feat Feature Minor
fix Bug Fixes Patch
perf Performance Improvements Patch
revert Reverts Patch
docs Documentation Patch
refactor Code Refactoring Patch
test Tests Patch
chore Chores Patch

TODO

[ ] add flag --merge-onlyto show only merges

About

Changelog generation as easy as typing asdf

License:Apache License 2.0


Languages

Language:Go 97.7%Language:Shell 2.3%