Release Notes Generator

Narzędzie do automatycznego generowania release notes z commitów Git z wykorzystaniem LLM.

Zespół

• Michał 55335 - Project Manager / Lead Developer
• Adrian 52645 - DevOps Engineer
• Emilia 52766 - UX Engineer
• Krystian 52883 - QA Engineer

Prowadzący:

mgr inż. Aleksandra Ata

Wymagania

• Python 3.8+
• Klucz API OpenAI

Instalacja

git clone https://github.com/ProXi-22/release_notes_generator
cd release_notes_generator
python -m venv .venv
source .venv/bin/activate      # macOS/Linux
.venv\Scripts\activate         # Windows
pip install -r requirements.txt

Konfiguracja

Utwórz plik .env w głównym katalogu projektu:

OPENAI_API_KEY=<klucz_API>

Uruchomienie

Tryb CLI

python main.py --repo <url_lub_ścieżka_lokalna> --od <commit_start> --do <commit_end>

Tryb GUI

python gui.py

Parametry

Parametr	Opis	Przykład
--repo	URL repozytorium GitHub lub ścieżka lokalna	https://github.com/user/repo lub .
--od	Commit/tag początku zakresu	HEAD~5, v1.0.0
--do	Commit/tag końca zakresu	HEAD, v1.1.0

Przykłady

Repozytorium zdalne (zostanie sklonowane tymczasowo):

python main.py --repo https://github.com/user/projekt --od HEAD~5 --do HEAD

Repozytorium lokalne (bieżący katalog):

python main.py --repo . --od HEAD~5 --do HEAD

Wynik

Po uruchomieniu w konsoli pojawi się:

Klonowanie repozytorium z: https://github.com/user/projekt
Znaleziono 5 commitów.

Generowanie release notes...
Zapisano: release_notes_projekt_2026-06-13.md

W katalogu roboczym zostanie zapisany plik release_notes_<nazwa-repo>_<data>.md z treścią w formacie Markdown, np.:

## Nowości
- Dodano obsługę argumentu --do w module CLI

## Poprawki błędów
- Naprawiono błąd przy klonowaniu repo z ukośnikiem na końcu URL

## Zmiany techniczne
- Wydzielono stałe konfiguracyjne do config.py

Testy

python -m pytest testy.py -v

Testy obejmuje moduł modul_git.py (3 testy jednostkowe).

Technologie

• GitPython — obsługa repozytoriów Git
• OpenAI Python SDK — komunikacja z GPT-4o-mini
• python-dotenv — wczytywanie zmiennych środowiskowych
• pytest — testy jednostkowe
• tkinter — interfejs graficzny