Girokmoji

Changelog Generator for Gitmoji enthusiasts

기록 + Gitmoji

Minimum Dependencies

We use minimum dependencies. Currently, only pygit2, which requires no runtime git executable, good enough binary distributions, is used.

Designed for General Use

Pipeline as a trigger

Pipelines, such as SCM provided ones (e.g., GitHub Actions), dedicated solutions (e.g., Jenkins) are best when you use it as a "trigger".

Do a single thing

This only generates release note. This project has no interest in versioning scheme, repository scheme (mono/poly war), even tag order. Just put two tags.

Basic use case

Clone

git clone https://github.com/KMilhan/girokmoji.git

Note: Please change repository url with your repository url. Also, clone with enough depth, so libgit2 can traverse to the past tag.

Installation

If you have uv, skip.

Or, In case you are sure you have isolated environment,

pip install girokmoji

Generate Release Note

with uv (recommended, especially for release pipelines)

uvx --from "girokmoji@latest" girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md

with isolated pip

python -m girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md

or

girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md

Example

For generated release note, go EXAMPLE.md