检查pom.xml是否符合github页面的mvn站点命令

Question

当尝试将我的开源项目发布到gh页面时

mvn site

由于maven和github页面工作方式的变化，最近出现了很多障碍。

学习后

• https://help.github.com/articles/creating-project-pages-using-the-command-line/
• https://maven.apache.org/plugins/maven-site-plugin/
• https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

以下是我发现的一些必要的先决条件和我遇到的问题：

先决条件

1. git branch需要显示gh pages分支，例如在使用中的命令后https://gist.github.com/ramnathv/2227408
2. maven站点插件和maven项目信息报告插件的版本必须正确且配置正确：maven站点插件3.3 java。lang.ClassNotFoundException：组织。阿帕奇。专家多夏。siterenderer。文档内容
3. 依赖关系。位置。enabled属性需要为false为什么我会遇到Maven错误：“无法确定中是否存在资源Xhttp://maven.glassfish.org/content/groups/glassfish“

问题

• 如何强制生成GitHub页面
• Maven：报告插件组织。阿帕奇。专家插件：maven project info reports插件的版本为空
• 马文：什么是插件管理
• 多模块POM-创建有效的网站
• Maven父/子插件配置继承问题

甚至没有提到我必须用于ssh-wago和Java8-javadoc等的变通方法

使用的插件恕我直言是一个“移动目标”。几个月前在我的经验中有效的东西今天不起作用。所以我不断修复我的pom.xml文件以跟上步伐，文件越来越长。

参见例如https://github.com/BITPlan/com.bitplan.simplerest/blob/master/pom.xml

对于我的内部项目，我使用父pom来确保项目具有公共配置。对于开源项目，我还没有找到将父pom用于一组项目的方法。

我想确保我找到的工作配置已“转移”到其他配置。我正在考虑，例如

1. 可能检查配置的脚本

我假设这是一个非常常见的问题，SO用户在不同的项目中都有处理这个问题的经验。

什么是好的方法，什么工具是有用的？

1. 带有pom包装的父pom maven中的“pom”包装是什么？主要说明了pom包装在多模块项目中的使用，但它看起来可以用于对父pom进行引用。父母路径默认为...参见Maven：不可解析的父POM。Maven中解释了配置的覆盖：是否可以覆盖已经为父POM中的配置文件定义的插件配置

移动目标示例

• Java8愚蠢的javadoc设置
  • 当Javadoc标签不完整时，Maven无法在Java8中工作
  • 如何在Maven Javadoc插件中禁用Javadoc警告？

Answer 1

正如khmarbaise所建议的，现在有了一个共同的父pom。

mvn site

可以使用带有一组通用报告的父pom为所有项目运行，结果将传输到相应的github页面。

项目专用pom现在可以短至25行

我现在实际上正在为pom文件创建一个检查脚本，并为自述文件创建一个生成脚本。md文件。这是一个有用的片段：

使用示例：

checkghpages https://github.com/BITPlan com.bitplan.simplerest

检查gh页面是否存在，并在询问后创建

#
# check the github pages for the given project
# 
# param 1: base url in github
# param 2: project name/directory
#
checkghpages() {
  local l_baseurl="$1"
  local l_project="$2"
  cd $ws/$l_project
  git ls-remote --heads | grep gh-pages > /dev/null
  if [ $? -ne 0 ]
  then
    color_msg $red "github pages branch gh-pages missing for $l_project"
    color_msg $blue "shall i create the branch gh-pages for $l_project?"
    read answer
    case $answer in
      y|Y|yes|Yes|j|Ja) 
        color_msg $blue "creating gh-pages branch for $l_project ..."
        cd /tmp
        # https://gist.github.com/ramnathv/2227408
        git clone $l_baseurl/$l_project
        cd $l_project
        git symbolic-ref HEAD refs/heads/gh-pages
        rm .git/index
        git clean -fdx
        echo "<a href='$l_baseurl/$l_project'>Initial GitHub Page for $l_project</a>" > index.html
        git add .
        git commit -a -m "First pages commit by checkos script"
        git push origin gh-pages
        cd $ws/$l_project
        git pull
      ;;
    esac
  else
    color_msg $green "github pages branch gh-pages for $l_project exists✓"
  fi
}