https://github.com/excalith/changeling

Generates changelogs between commit hashes and creates a clean markdown file sections from commit message prefixes
https://github.com/excalith/changeling

app changelog changelog-formatter changelog-generator git node screenshot terminal-app

Last synced: about 1 year ago
JSON representation

Generates changelogs between commit hashes and creates a clean markdown file sections from commit message prefixes

• Host: GitHub
• URL: https://github.com/excalith/changeling
• Owner: excalith
• License: mit
• Created: 2018-10-02T16:53:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-10-15T16:09:30.000Z (over 7 years ago)
• Last Synced: 2024-10-12T07:50:01.587Z (over 1 year ago)
• Topics: app, changelog, changelog-formatter, changelog-generator, git, node, screenshot, terminal-app
• Language: JavaScript
• Homepage:
• Size: 5.92 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


	
Changeling - A Changelog Generator





    Generates changelogs between commit hashes and creates a clean markdown file with commit prefix sections





    





	

		

	

	

		

	

	

		

	

	

		

	





**Changeling** helps you to generate changelogs between commit hashes easily. Depending on your commit message prefixes, your changelog will be created with markdown sections and commit messages with corresponding hashes.

## How To Install:

- Requirements

  - [NodeJS](https://nodejs.org)

  - [NPM](https://www.npmjs.com/get-npm)

- Clone or Download this repository

- Within the directory, from your favorite terminal

  - `npm install`

  - `npm link` (might ask for permission depending on your OS)

- Now you can use `clog` or `changelog` right from your terminal!

## How To Use:

In order to use the app, please follow **How To Install** steps above.

When you complete installation, you can run commands below

### Available Commands:

| _Command_ | _Description_                |

| --------- | ---------------------------- |

| clog      | Run Changeling               |

| clog -s   | Open Settings File In Editor |

| clog -h   | Display This Help            |

### Generating Log File

Whenever you run `clog` app will run by default. You need to fill required fields to generate your changelog. When you are done, changelog will be saved in your git directory.

| _Settings_       | _Description_                                                                       |

| ---------------- | ----------------------------------------------------------------------------------- |

| Title            | Title for your new changelog (ie. Milestone 5)                                      |

| From Commit Hash | Pick from which commit you want to include commits                                  |

| To Commit Hash   | Pick which commit you want to end fetching commits                                  |

| Append or Create | If you generated a changelog before, you can append to it or create a new changelog |

| Check Settings   | Check your settings before creating                                                 |

### Settings

You can update settings by using `clog -s` command. This will open config file within your beloved editor.

Default Settings:

| _Key_           | _Value_      |

| --------------- | ------------ |

| prefixes        | Add          |

|                 | Remove       |

|                 | Improve      |

|                 | Change       |

|                 | Update       |

|                 | Refactor     |

|                 | Fix          |

| defaultFileName | Changelog.md |

| tempFileName    | tempLog.txt  |

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.