0

Initial Maven site implementation

This commit is contained in:
rjenkinsjr
2016-03-28 23:35:47 -04:00
parent 72481f2a1a
commit 62f1457678
7 changed files with 452 additions and 6 deletions

212
pom.xml
View File

@@ -23,12 +23,18 @@
<version>0.1.0-SNAPSHOT</version>
<name>SLF4Bukkit</name>
<description>SLF4J binding that uses Bukkit's plugin logging system.</description>
<url>http://rjenkinsjr.github.io/slf4bukkit</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
<maven.javadoc.version>2.10.3</maven.javadoc.version>
<sonar.java.source>${maven.compiler.source}</sonar.java.source>
<rtr.allowExternalSnapshots>true</rtr.allowExternalSnapshots>
<site.src>${project.basedir}/src/site</site.src>
<site.dest>${project.basedir}/target/site-src</site.dest>
<site.profile>pre-release</site.profile>
<github.site.dir>${project.basedir}/src/github</github.site.dir>
<tagNameFormat>@{project.version}</tagNameFormat>
</properties>
<scm>
@@ -45,16 +51,15 @@
</licenses>
<!-- Dependencies -->
<dependencies>
<dependency>
<groupId>org.bukkit</groupId>
<artifactId>bukkit</artifactId>
<version>1.9-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.19</version>
</dependency>
<dependency>
<groupId>org.bukkit</groupId>
<artifactId>bukkit</artifactId>
<version>1.9-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
</dependencies>
@@ -72,7 +77,155 @@
</includes>
</resource>
</resources>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
<executions>
<!-- Filter site resources. -->
<execution>
<id>copy-site-resources</id>
<phase>pre-site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${site.dest}</outputDirectory>
<resources>
<resource>
<directory>${site.src}</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<!-- Site plugin configuration. -->
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.4</version>
<configuration>
<!-- Use renamed site files. -->
<siteDirectory>${site.dest}</siteDirectory>
<!-- Don't use this plugin to deploy anything. -->
<skipDeploy>true</skipDeploy>
</configuration>
</plugin>
<!-- Custom scripting. -->
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.8</version>
<executions>
<!-- Rename site files to Velocity templates. -->
<execution>
<id>preprocess-site-velocity-templates</id>
<phase>pre-site</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<move todir="${site.dest}" includeemptydirs="false">
<fileset dir="${site.dest}" includes="**/*.md" />
<globmapper from="*.md" to="*.md.vm" />
</move>
</target>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<!-- Manages site/report configuration. -->
<reporting>
<plugins>
<!-- Basic reports -->
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.8.1</version>
<configuration>
<dependencyLocationsEnabled>false</dependencyLocationsEnabled>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>issue-tracking</report>
<report>mailing-list</report>
<report>project-team</report>
<report>dependencies</report>
<report>dependency-management</report>
<report>dependency-convergence</report>
<report>plugins</report>
<report>scm</report>
<report>cim</report>
<report>distribution-management</report>
<report>summary</report>
<report>license</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- Javadocs -->
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven.javadoc.version}</version>
<reportSets>
<reportSet>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- Source XRef -->
<plugin>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.5</version>
<reportSets>
<reportSet>
<reports>
<report>jxr</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- TODOs, etc. -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>taglist-maven-plugin</artifactId>
<version>2.4</version>
<configuration>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>To-dos</displayName>
<tags>
<tag>
<matchString>TODO</matchString>
<matchType>ignoreCase</matchType>
</tag>
<tag>
<matchString>FIXME</matchString>
<matchType>ignoreCase</matchType>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>Deprecations</displayName>
<tags>
<tag>
<matchString>@deprecated</matchString>
<matchType>ignoreCase</matchType>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
</reporting>
<profiles>
<!-- SonarQube analysis profile. -->
<profile>
@@ -111,6 +264,7 @@
</property>
</activation>
<build>
<defaultGoal>clean deploy site-deploy</defaultGoal>
<plugins>
<!-- Write POM version to properties file. -->
<plugin>
@@ -133,6 +287,52 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<!-- Generate GitHub README.md. -->
<execution>
<id>generate-github-readme</id>
<phase>site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.basedir}</outputDirectory>
<resources>
<resource>
<directory>${github.site.dir}</directory>
<includes>
<include>README.md</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
<overwrite>true</overwrite>
</configuration>
</execution>
</executions>
</plugin>
<!-- Push Maven site to GitHub. -->
<plugin>
<groupId>com.github.github</groupId>
<artifactId>site-maven-plugin</artifactId>
<version>0.12</version>
<executions>
<execution>
<id>push-site-to-github</id>
<phase>site-deploy</phase>
<goals>
<goal>site</goal>
</goals>
<configuration>
<server>github</server><!-- settings.xml -->
<message>Publishing site for version ${project.version}</message>
<merge>true</merge>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>