release-notes-gen
Turn git history into readable release notes. Use when publishing releases.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Turn git history into readable release notes. Use when publishing releases.
How to use
Upewnij się, że masz zainstalowany Node.js w wersji 18 lub nowszej oraz ustawioną zmienną środowiskową OPENAI_API_KEY z kluczem do OpenAI.
Przejdź do katalogu projektu, w którym chcesz wygenerować notatki wydania. Narzędzie będzie czytać historię gita z tego miejsca.
Uruchom narzędzie z tagiem, od którego chcesz zacząć: npx ai-release-notes --from v1.0.0. Zastąp v1.0.0 numerem wersji, od której mają być uwzględnione commity.
Jeśli chcesz wygenerować notatki między dwiema wersjami, dodaj parametr --to: npx ai-release-notes --from v1.0.0 --to v2.0.0.
Aby zmienić ton notatek na bardziej swobodny, użyj flagi --tone fun. Narzędzie automatycznie pogrupuje zmiany po kategoriach, usunie żargon techniczny i przedstawi je w wybranym stylu.
Skopiuj wygenerowany tekst do notatek wydania na GitHubie, posta na blogu lub wiadomości dla użytkowników.