https://github.com/stbaer/release-history

History markdown from tags
https://github.com/stbaer/release-history

helper history javascript node tool workflow

Last synced: about 2 months ago
JSON representation

History markdown from tags

• Host: GitHub
• URL: https://github.com/stbaer/release-history
• Owner: stbaer
• License: mit
• Created: 2017-01-17T14:07:33.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2017-05-08T22:59:33.000Z (about 9 years ago)
• Last Synced: 2025-10-11T15:54:23.347Z (9 months ago)
• Topics: helper, history, javascript, node, tool, workflow
• Language: JavaScript
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# release-history

> History markdown from git tags

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

## Usage

Install:

```bash

$ npm i -g release-history

```

CLI:

```bash

$ release-history --help

Usage: release history.js [options] [command]

  Commands:

    help  Display help

  Options:

    -c, --commit-base-url         set the remote url for linking to commits, e.g. https://github.com/stbaer/release-history/commits (defaults to "")

    -d, --dry-run                 only log commands without executing them (disabled by default)

    -e, --exclude-strings   excludes a commit if its title contains this string (defaults to [])

    -h, --help                    Output usage information

    -i, --include-strings   includes a commit if its title contains this string (defaults to [])

    -o, --out [value]             output file (defaults to "History.md")

    -v, --version                 Output the version number

```

## Licence

MIT, see [LICENSE](https://github.com/stbaer/release-history/blob/master/LICENSE) for details.