rsyslog-doc-dist
Automatycznie synchronizuj pliki dokumentacji z konfiguracją buildu
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill dla rsyslog, który pilnuje, aby wszystkie pliki dokumentacji w formacie RST były poprawnie zarejestrowane w pliku doc/Makefile.am. Kiedy dodasz, przeniesiesz lub usuniesz plik dokumentacji w katalogu doc/source/, skill automatycznie sprawdza, czy wpis w zmiennej EXTRA_DIST jest zsynchronizowany. Zapobiega błędom podczas tworzenia dystrybucji źródłowej (make dist) i gwarantuje, że dokumentacja będzie prawidłowo spakowana w archiwum tarball oraz zbudowana z niego.
Jak używać
Kiedy dodajesz nowy plik RST w katalogu doc/source/, otwórz plik doc/Makefile.am i dodaj ścieżkę do zmiennej EXTRA_DIST, zachowując istniejące logiczne grupowanie (np. source/configuration/modules/).
Jeśli przeniesiesz lub zmienisz nazwę pliku dokumentacji, zlokalizuj starą ścieżkę w doc/Makefile.am i zastąp ją nową lokalizacją.
Gdy usuwasz plik dokumentacji, znajdź jego wpis w doc/Makefile.am i usuń go całkowicie, aby uniknąć błędów podczas make dist.
Po każdej zmianie (dodanie, przeniesienie lub usunięcie) uruchom skrypt weryfikacyjny: bash .agent/skills/rsyslog_doc_dist/scripts/check-doc-dist.sh
Skrypt automatycznie sprawdzi wersję projektu, uruchomi make dist, rozpakuje dystrybucję w katalogu tymczasowym, uruchomi configure oraz make html, a następnie wyczyści pliki tymczasowe.
Jeśli skrypt zakończy się bez błędów, Twoja dokumentacja jest poprawnie zsynchronizowana i będzie dostępna w dystrybucji źródłowej.