Toolverse
Wszystkie skille

gen-changelog

autor: MoonshotAI

Generuj wpisy do dziennika zmian na podstawie modyfikacji kodu

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
DevOps
Wyświetlenia
9

O skillu

Skill automatyzuje tworzenie wpisów do CHANGELOG na podstawie zmian w gałęzi kodu. Analizuje commity względem głównej gałęzi, aktualizuje pliki CHANGELOG w katalogu głównym i podpakietach, synchronizuje dokumentację w języku angielskim i chińskim, a także dodaje wpisy o zmianach powodujących niezgodność wsteczną. Oszczędza czas przy utrzymaniu dokumentacji zmian w projektach wielojęzycznych.

Jak używać

  1. Upewnij się, że masz dostęp do repozytorium i jesteś na gałęzi zawierającej zmiany, które chcesz udokumentować. Skill będzie porównywać twoją gałąź z gałęzią główną (main).

  2. Uruchom skill, który przeanalizuje wszystkie commity i różnice między twoją gałęzią a main za pomocą git log main..HEAD --oneline i git diff main..HEAD --stat, aby zrozumieć zakres zmian.

  3. Skill automatycznie doda wpisy do pliku CHANGELOG.md w katalogu głównym pod sekcją ## Unreleased. Jeśli zmiany dotyczą podpakietów w katalogach packages/ lub sdks/, skill zaktualizuje również odpowiednie pliki CHANGELOG.md w tych katalogach.

  4. Skill uruchomi skrypt synchronizacji (node docs/scripts/sync-changelog.mjs), aby przenieść wpisy z głównego CHANGELOG do dokumentacji angielskiej w pliku docs/en/release-notes/changelog.md.

  5. Skill doda chińskie tłumaczenia wpisów do pliku docs/zh/release-notes/changelog.md pod sekcją ## 未发布, zgodnie z istniejącymi konwencjami terminologicznymi i formatowaniem zdefiniowanymi w docs/AGENTS.md.

  6. Jeśli zmiany zawierają modyfikacje powodujące niezgodność wsteczną (usunięcie opcji, zmiana domyślnych zachowań, migracja formatu konfiguracji), skill doda odpowiednie wpisy do plików docs/en/release-notes/breaking-changes.md i docs/zh/release-notes/breaking-changes.md w sekcji ## Unreleased / ## 未发布.

Podobne skille