Rendere JavaDocs disponibili con GitHub, Sonatype Maven repo

Question

Anche se Github fornisce una bella casa per i progetti open source Java, ci sono alcune cose che sono ancora mancanti rispetto ai luoghi di hosting open source più maturi. Finora ho capito che Sonatype offre accesso al repository Maven per progetti open source, che risolve un problema; e ci sono molte soluzioni per le mailing list utente/dev.

Ma una cosa che sto cercando di risolvere è quella di pubblicare javadoc generati automaticamente per la navigazione online. Anche se pubblicare i file sorgente tramite Maven aiuta un po 'con gli IDE, mi piace ancora la possibilità di navigare su javadoc online senza scaricare o importare un progetto. Qualcuno sa di un buon modo per raggiungere questo obiettivo, per i progetti ospitati presso Github? (non deve essere qualcosa che Github offre, ma idealmente qualcosa che può essere automatizzato quando si taglia)

Answer 1

GitHub serve file HTML statici che si trovano nel repository gh-pages a http://your_username.github.com/your_repo/. In teoria, Maven potrebbe essere fatto per:

1. Confermare il rilascio pom.xml.
2. Genera JavaDocs in una directory .gitignore 'd (in modo da essere conservata tra le modifiche delle diramazioni).
3. Verificare il ramo gh-pages.
4. sostituire tutti i file nella directory di lavoro con quello della directory dei JavaDocs sono stati copiati
5. Commit
6. Acquista il ramo originale.
7. Continuare con il rilascio ...

Sono solo due giorni in all'utilizzo di Maven per alcuni dei miei progetti, quindi questo è ben oltre le mie capacità. Sarei impaziente di vederlo implementato con plug-in esistenti o plug-in personalizzati.

Answer 2

È possibile utilizzare uno script di shell per eseguire il checkout git/add/commit/checkout/push come suggerito da Jake Wharton e configurare Ant o Gradle per eseguire lo script della shell dopo aver generato javadoc. Non sono sicuro che questo funzionerebbe con Maven. Ecco uno example shell script.

Answer 3

Esiste ora un plug-in Maven che può inviare una directory a un ramo specifico su githib a: http://github.com/github/maven-plugins.

Answer 4

È possibile utilizzare le pagine github, creando un sito Web statico, quindi si inserisce la javadoc in una directory e si esegue il commit del ramo gh-pages.

vedere le pagine del mozzo Git, è semplice e utile.

vedere

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