https://github.com/unic/changelog-generator

Automatic changelog generator
https://github.com/unic/changelog-generator

Last synced: about 2 months ago
JSON representation

Automatic changelog generator

• Host: GitHub
• URL: https://github.com/unic/changelog-generator
• Owner: unic
• Created: 2019-02-18T13:08:15.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-30T11:44:17.000Z (over 1 year ago)
• Last Synced: 2024-04-14T05:50:42.145Z (9 months ago)
• Language: JavaScript
• Size: 406 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.css

Awesome Lists containing this project

README

        
# Changelog Generator

Compare built preview markup of two tags from the same repository with [`icdiff`](https://github.com/jeffkaufman/icdiff) and output a HTML changelog page.

![Changelog Output](screenshot.png)

## Installation

Clone the repository and run `npm install`.

## Usage

Works by passing a repository url, preview generation command, preview folder and the tags to compare (old/new):

> $ npm start -- https://url-to-repository.git --old-tag=v1.18.0 --new-tag=v1.19.0 --preview-cmd="npm run preview" --preview-folder=build/preview

### Options

Optionally you can use following options:

* `--ignore-files`: Pass a regular expression to completly ignore changes from matching files (default `"(.js|.css|index.html)$"`)

* `--exclude-lines`: Pass regex to check for lines that should be ignored (default `''`)

* `--cols`: Set the number of characters per line (default `220`)

* `--context`: Set the number of lines to display before and after a comparison (default is `7`)

* `--preview-url`: Pass a url to generate links to an online preview

* `--preview-generate=false`: Prevent cloning the repository, checking out the tags and generating the previews (useful when if already done)