Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Auto-generate tables describing the first-party starters

Browse Source 
Previously, the documentation included hand-written tables for the
application, production, and technical starters.

This commit replaces the hand-written tables with tables that are
generated automatically from all of the starter poms, thereby ensuring
that the documentation is automatically kept up-to-date as starters
are added and removed. An extra column provided a link to each
starter's pom on GitHub has also been added to the table. This makes
it easier for users to see exactly what each starter contains.

Closes gh-5267
This commit is contained in:
Andy Wilkinson
2016-03-29 17:19:29 +01:00
parent 2b649542e0
commit fec53970f7
55 changed files with 280 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
spring-boot-docs/pom.xml
View File

@@ -39,6 +39,12 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-loader-tools</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starters</artifactId>
<type>pom</type>
<version>${project.version}</version>
</dependency>
<!-- Optional deps required when generating Javadoc with Java 8 -->
<dependency>
<groupId>ch.qos.logback</groupId>
@@ -609,6 +615,26 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>copy-starters-pom</id>
<phase>generate-resources</phase>
<goals>
<goal>copy</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starters</artifactId>
<version>${project.version}</version>
<type>pom</type>
<overWrite>true</overWrite>
<outputDirectory>${project.build.directory}/external-resources</outputDirectory>
<destFileName>starters-effective-pom.xml</destFileName>
</artifactItem>
</artifactItems>
</configuration>
</execution>
<execution>
<id>unpack-maven-plugin</id>
<phase>generate-resources</phase>
@@ -680,6 +706,25 @@
</artifactItems>
</configuration>
</execution>
<execution>
<id>unpack-starter-poms</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starters</artifactId>
<version>${project.version}</version>
<type>zip</type>
<classifier>starter-poms</classifier>
<outputDirectory>${project.build.directory}/external-resources/starter-poms</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
@@ -697,6 +742,9 @@
<transformationSets>
<transformationSet>
<dir>${project.build.directory}/external-resources</dir>
<includes>
<include>effective-pom.xml</include>
</includes>
<stylesheet>src/main/xslt/dependencyVersions.xsl</stylesheet>
<fileMappers>
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
@@ -722,6 +770,7 @@
<configuration>
<scripts>
<script>file:///${project.basedir}/src/main/groovy/generateAutoConfigurationClassTables.groovy</script>
<script>file:///${project.basedir}/src/main/groovy/generateStarterTables.groovy</script>
</scripts>
</configuration>
<dependencies>