https://github.com/okineadev/gitpaper
📰 The first ever generator of non-boring and actually detailed release notes
https://github.com/okineadev/gitpaper
changelog changelog-generator conventional-commits release-automation release-notes
Last synced: 5 months ago
JSON representation
📰 The first ever generator of non-boring and actually detailed release notes
- Host: GitHub
- URL: https://github.com/okineadev/gitpaper
- Owner: okineadev
- License: mit
- Created: 2025-07-21T09:33:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-06T18:49:30.000Z (5 months ago)
- Last Synced: 2025-10-06T20:43:15.075Z (5 months ago)
- Topics: changelog, changelog-generator, conventional-commits, release-automation, release-notes
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# **`gitpaper`**
> The first ever generator of non-boring and actually detailed release notes
> [!NOTE]
> The project is still under development and can already be used in some real-world cases, but the settings/principle of operation may change without notice before the first major version is released, so don't be upset if something breaks.
## 🛠️ Usage
```bash
npx gitpaper
```
`gitpaper` will automatically generate release notes starting from the last release to the last commit by default.
Here is an example of the generated Markdown:
### 🚀 Enhancements
- Add support for terminal hyperlinks - by Dev Khalid [(7e21c)](https://github.com///commit/7e21c3f4a1b2c5d6e7f8090a12b34c56d78e90f1)
> Now terminal links are clickable in supported environments, making logs and CLI output more interactive (and less copy-pasty).
### 🐛 Fixes
- Resolve crash when reading empty config files - by Mei-Ling Zhou [(c1d45)](https://github.com///commit/c1d45ef7a9bc4321def56789abcde0123456789f)
> Prevented an edge case crash when config files exist but contain... absolutely nothing. Now it fails gracefully and logs a warning.
---
The main feature is extended descriptions of changes in release notes, which makes it much clearer for your users
To have these descriptions appear in your release notes, you need to insert a special `::: changelog` section in the extended commit description:
```plaintext
Multiline strings were inconsistently parsed when using backticks inside templates.
Tested on macOS, Ubuntu, and Windows 11 (PowerShell and Git Bash).
::: changelog
Enhanced the parser to correctly capture multiline strings, especially those using backticks.
No more chopped-off input on line breaks in the final output.
:::
Fixes #123
Co-authored-by: Chloe Nakamura
Co-authored-by: Viktor Petrov
```
So you decide what exactly should be written in the release notes.
## ❤️ Support
If you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or [buying me a coffee ☕](https://github.com/okineadev/vitepress-plugin-llms?sponsor=1)
## 📜 License
[MIT License](./LICENSE) © 2025-present [Yurii Bogdan](https://github.com/okineadev)
## 👨🏭 Contributors
Thank you to everyone who helped with the project!
