Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrianlee44/lorax
Node package to generate changelog with formatted git commits
https://github.com/adrianlee44/lorax
changelog generator javascript node
Last synced: about 2 months ago
JSON representation
Node package to generate changelog with formatted git commits
- Host: GitHub
- URL: https://github.com/adrianlee44/lorax
- Owner: adrianlee44
- License: mit
- Created: 2013-12-06T17:23:38.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T05:35:51.000Z (about 1 year ago)
- Last Synced: 2024-05-01T00:46:35.300Z (8 months ago)
- Topics: changelog, generator, javascript, node
- Language: TypeScript
- Homepage:
- Size: 593 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Lorax
[](https://codecov.io/gh/adrianlee44/lorax)
[](https://github.com/adrianlee44/lorax/blob/master/LICENSE-MIT)
[](https://www.npmjs.org/package/lorax)
Lorax is a node package to generate changelog by parsing formatted git commits. One of the problems people run into when working with an open-sourced project is having trouble knowing what have been fixed, updated or created. Some people solve this problem by reading through the git log while other might ask on Github issue or Stackoverflow.
Lorax tries to solve this problem by automating the changelog generation process. Lorax will read through all the commits between tags and generate an easy to read markdown changelog.
[View Lorax's changelog as an example](https://github.com/adrianlee44/lorax/blob/master/changelog.md)
## Example
Using Lorax git commit log as an example
```
commit 76adc163ab03e7e6faf553f3e9ef86b4ab1e31b7
Author: Adrian Lee <[email protected]>
Date: Wed Dec 11 02:11:24 2013 -0800
chore(lorax.json): Switched to use https
commit 997fe15d42e5f59264edc7e8291c97785d5988f0
Author: Adrian Lee <[email protected]>
Date: Wed Dec 11 02:11:07 2013 -0800
feature(git): Updated getLog function so read all logs when no tag is provided
commit c1cffd76f985bf267bb1983002ab368129a11735
Author: Adrian Lee <[email protected]>
Date: Fri Dec 6 09:26:45 2013 -0800
feature(all): Initial commit
```
Lorax will generate a changelog
```markdown
# v0.1.0 (2013/12/13)
## Features
- **all:** Initial commit
([c1cffd76](https://github.com/adrianlee44/lorax/commit/c1cffd76f985bf267bb1983002ab368129a11735))
- **git:** Updated getLog function so read all logs when no tag is provided
([997fe15d](https://github.com/adrianlee44/lorax/commit/997fe15d42e5f59264edc7e8291c97785d5988f0))
```
## Installation
```bash
$ npm install -g lorax
```
## Usage
```bash
Usage: lorax -t [tag] [options]
Options:
-V, --version output the version number
-F, --file [FILE] Name of the file to write to [changelog.md] (default: "changelog.md")
-p, --prepend Prepend to the file
-s, --since [tag] Starting tag version
-t, --tag [tag] Tag of the upcoming release [2.1.0] (default: "2.1.0")
-h, --help display help for command
```
To generate the changelog
```bash
$ lorax -t v0.1.0 -F changelog.md
```
## Git commit format
```
type(component): commit message
detailed message
BREAKING CHANGES
- Nothing really
Fixes #123
```
Example
```
feature(lorax): Hello World
Close #321
```
## Configurations
Project can add `lorax.json` in root directory to override default settings
```js
{
issue: "/issues/%s",
commit: "/commit/%s",
types: {
fix: {
title: 'Bug Fixes',
regex: '^fix',
},
feature: {
title: 'Features',
regex: '^feat(ure)?',
},
breaking: {
title: 'Breaking Changes',
regex: 'BREAKING',
},
refactor: {
title: 'Optimizations',
regex: '^refactor',
},
test: {
title: 'Testing',
regex: '^test',
},
doc: {
title: 'Documentation',
regex: '^doc',
},
},
url: "https://github.com/adrianlee44/lorax"
}
```
| key | description | Default |
| ------ | -------------------------------------------------------------------------- | ------------ |
| issue | Partial URL for issues | `/issues/%s` |
| commit | Partial URL for commits | `/commit/%s` |
| types | Configuration including display title and regex for type of commit message | See above |
| url | URL of the repo | '' |