使JavaDocs可用于GitHub,Sonatype Maven repo [已关闭]

2022-09-01 22:43:38

尽管Github为Java开源项目提供了一个很好的家,但与更成熟的开源托管场所相比,仍然有一些东西仍然缺失。到目前为止,我已经发现Sonatype为开源项目提供了Maven存储库访问权限,这解决了一个问题;并且有许多用于用户/开发人员邮件列表的解决方案。

但是我现在试图解决的一件事是发布自动生成的javadocs用于在线浏览。虽然通过 Maven 发布源代码 jar 对 IDE 有一点帮助,但我仍然喜欢在不下载或导入项目的情况下在线浏览 javadocs 的功能。有谁知道一个好方法来实现这一点,对于在Github上托管的项目?(不一定是Github提供的东西,但理想情况下,当发布被切断时,可以自动发生的东西)


答案 1

GitHub 提供静态 HTML 文件,这些文件位于 存储库的分支中。从理论上讲,Maven可以执行以下操作:gh-pageshttp://your_username.github.com/your_repo/

  1. 提交发布 。pom.xml
  2. 将 JavaDocs 生成到 'd 目录(以便跨分支更改保留它)。.gitignore
  3. 签出分支。gh-pages
  4. 将工作目录中的所有文件替换为 JavaDocs 复制到的目录的文件
  5. 签出原始分支。
  6. 继续发布...

我只有两天的时间就使用Maven来完成我的一些项目,所以这远远超出了我的能力。我渴望看到使用现有插件或自定义插件实现这一点。


答案 2

现在有一个Maven插件可以将目录推送到githib上的特定分支:http://github.com/github/maven-plugins


推荐