https://github.com/gladiuscode/gittyloggy
This is an utility that will generate a changelog based on the last tagged commit
https://github.com/gladiuscode/gittyloggy
Last synced: 11 months ago
JSON representation
This is an utility that will generate a changelog based on the last tagged commit
- Host: GitHub
- URL: https://github.com/gladiuscode/gittyloggy
- Owner: gladiuscode
- License: mit
- Created: 2024-04-05T10:52:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T18:09:15.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T09:40:41.237Z (11 months ago)
- Language: TypeScript
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GittyLoggy
This library can be used in your projects to properly generate a changelog
that all your PMs and Testers all around the world love so much.
## Installation
```bash
yarn -D gittyloggy
```
Or using npm
```bash
npm --save-dev gittyloggy
```
## How to use
Add a new script to your project package.json
```json5
{
"scripts": {
"gitty": "cl"
}
}
```
Then add a new gittyconfig.json file in the root of your project with the following properties
```json5
{
"PEOPLE_TAGS": "your pm and testers tags",
"PIPELINE_URL": "your pipeline url",
"VERSION": "your version",
"TAG": "your tag to look up to",
"ONLY_MERGED_PRS": true
}
```
This command will output a proper changelog that you can copy and paste wherever you need to.
## Roadmap
- [X] Release on npm
- [] Add support for multiple languages
- [] Add support to run plugins so that each changelog output can be further customize to meet devs needs