Создание JavaDocs в GitHub, Sonatype Maven repo

Хотя Github обеспечивает хороший дом для проектов с открытым исходным кодом Java, есть некоторые вещи, которые по-прежнему отсутствуют по сравнению с более зрелыми местами размещения с открытым исходным кодом. Я до сих пор понял, что Sonatype предлагает доступ к хранилищу Maven для проектов с открытым исходным кодом, который решает одну проблему; и существует множество решений для списков рассылки пользователей/разработчиков.

Но одна вещь, которую я сейчас пытаюсь решить, - это публикация автоматически созданных javadocs для онлайн-просмотра. Хотя публикация исходных банок через Maven помогает немного с IDE, мне по-прежнему нравится возможность просматривать javadocs онлайн без загрузки или импорта проекта. Кто-нибудь знает о хорошем способе достижения этого, для проектов, размещенных в Github? (не обязательно, чтобы Github предлагал, но в идеале что-то, что может быть автоматизировано, когда релиз разрезан)

Ответы

Ответ 1

GitHub обслуживает статические HTML файлы, которые находятся в ветке gh-pages вашего репо в http://your_username.github.com/your_repo/. Теоретически, Maven можно было сделать так:

  • Заблокировать выпуск pom.xml.
  • Сгенерируйте JavaDocs в каталог .gitignore 'd (поэтому он будет сохранен во всех изменениях ветвления).
  • Обратите внимание на ветвь gh-pages.
  • Замените все файлы в рабочем каталоге на каталог, который были скопированы в JavaDocs, на
  • Фиксировать
  • Оформить оригинальную ветку.
  • Продолжить выпуск...

Мне нужно всего два дня использовать Maven для нескольких моих проектов, так что это выходит за рамки моих возможностей. Я бы хотел увидеть, что это реализовано либо с помощью существующих плагинов, либо с помощью специального плагина.

Ответ 2

Теперь есть плагин Maven, который может подталкивать каталог к ​​определенной ветки на githib по адресу: http://github.com/github/maven-plugins.

Ответ 3

Вы можете использовать оболочку script для выполнения git checkout/add/commit/checkout/push, как предложил Джейк Уортон, и настроить Ant или Gradle для запуска оболочки script после ее создания javadoc. Я не уверен, что это сработает с Maven. Здесь пример оболочки script.

Ответ 4

Вы можете использовать страницы github, создавая статический веб-сайт, после чего вы помещаете свой javadoc в каталог и передаете ветку gh-pages.

см. страницы концентратора Git, его простые и полезные.

см

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