Udostępnianie dokumentacji JavaDocs z GitHub, Sonatype Maven repo

Question

Mimo że Github zapewnia miły dom dla projektów open source w Javie, wciąż brakuje pewnych rzeczy w porównaniu do bardziej dojrzałych hostów open source. Do tej pory zdałem sobie sprawę, że Sonatype oferuje dostęp do repozytorium Maven dla projektów open source, który rozwiązuje jeden problem; i istnieje wiele rozwiązań dla list mailingowych użytkowników/dev.

Jedną z rzeczy, którą teraz próbuję rozwiązać, jest publikowanie automatycznie generowanych javadocs do przeglądania online. Chociaż publikowanie słoików źródłowych za pośrednictwem Mavena pomaga trochę z IDE, nadal lubię możliwość przeglądania javadocs online bez pobierania lub importowania projektu. Czy ktokolwiek wie o dobrym sposobie osiągnięcia tego celu w przypadku projektów hostowanych w Github? (nie musi być czymś, co oferuje Github, ale najlepiej czymś, co może zostać zautomatyzowane, kiedy nastąpi zwolnienie).

Answer 1

GitHub służy do wyświetlania statycznych plików HTML w gałęzi gh-pages na stronie http://your_username.github.com/your_repo/. Teoretycznie Maven może być stworzony, aby wykonać następujące czynności:

1. Zatwierdzić wydanie pom.xml.
2. Wygeneruj JavaDocs do katalogu d (.gitignore), aby zachować wszystkie zmiany w gałęziach.
3. Zamówienie oddziału gh-pages.
4. Wymień wszystkie pliki w katalogu roboczym z tym z Katalogu Javadocs zostały skopiowane do
5. Commit
6. Zamówienie oryginalny oddział.
7. Kontynuuj wydaniu ...

Jestem tylko dwa dni do korzystania z Maven na kilka moich projektów, więc to jest poza moimi możliwościami. Z chęcią zobaczę to zaimplementowane z istniejącymi wtyczkami lub niestandardową wtyczką.

Answer 2

Możesz użyć skryptu powłoki, aby wykonać polecenie git checkout/add/commit/checkout/push, jak zasugerował Jake Wharton, i skonfigurować Ant lub Gradle, aby uruchomić skrypt powłoki po wygenerowaniu javadoc. Nie jestem pewien, czy to zadziała z Mavenem. Oto example shell script.

Answer 3

Istnieje teraz wtyczka Maven, która może przesłać katalog do konkretnej gałęzi na githib pod adresem: http://github.com/github/maven-plugins.

Answer 4

Możesz użyć stron github, tworząc statyczną stronę internetową, a następnie umieść javadoc w katalogu i prowadź do gałęzi gh-pages.

zobacz strony hubów Git, proste i użyteczne.

zobaczyć

http://readwrite.com/2013/11/27/github-pages-explained#awesm=~oII5EQELsqV6S7