Merge pull request #11045 from izeye:gh-10633
* pr/11045: Update "Building reference documentation" section
This commit is contained in:
commit
1a0444f659
|
|
@ -131,7 +131,7 @@ available so you need to build that first since it's not generated by default.
|
||||||
|
|
||||||
[indent=0]
|
[indent=0]
|
||||||
----
|
----
|
||||||
$ ./mvnw clean install -pl spring-boot-tools/spring-boot-maven-plugin -Pdefault,full
|
$ ./mvnw clean install -pl spring-boot-project/spring-boot-tools/spring-boot-maven-plugin -Pdefault,full
|
||||||
----
|
----
|
||||||
|
|
||||||
The documentation also includes auto-generated information about the starters. You might
|
The documentation also includes auto-generated information about the starters. You might
|
||||||
|
|
@ -140,17 +140,17 @@ it:
|
||||||
|
|
||||||
[indent=0]
|
[indent=0]
|
||||||
----
|
----
|
||||||
$ ./mvnw clean install -f spring-boot-starters
|
$ ./mvnw clean install -f spring-boot-project/spring-boot-starters
|
||||||
----
|
----
|
||||||
|
|
||||||
Once this is done, you can build the reference documentation with the command below:
|
Once this is done, you can build the reference documentation with the command below:
|
||||||
|
|
||||||
[indent=0]
|
[indent=0]
|
||||||
----
|
----
|
||||||
$ ./mvnw clean prepare-package -pl spring-boot-docs -Pdefault,full
|
$ ./mvnw clean prepare-package -pl spring-boot-project/spring-boot-docs -Pdefault,full
|
||||||
----
|
----
|
||||||
|
|
||||||
TIP: The generated documentation is available from `spring-boot-docs/target/contents/reference`
|
TIP: The generated documentation is available from `spring-boot-project/spring-boot-docs/target/contents/reference`
|
||||||
|
|
||||||
|
|
||||||
== Modules
|
== Modules
|
||||||
|
|
|
||||||
|
|
@ -201,22 +201,53 @@
|
||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.apache.maven.plugins</groupId>
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
<artifactId>maven-invoker-plugin</artifactId>
|
<artifactId>maven-invoker-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
|
||||||
|
</configuration>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>prepare-integration-test</id>
|
||||||
|
<phase>pre-integration-test</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>install</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
<execution>
|
||||||
|
<id>integration-test</id>
|
||||||
|
<goals>
|
||||||
|
<goal>run</goal>
|
||||||
|
</goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
|
<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
|
||||||
<settingsFile>src/it/settings.xml</settingsFile>
|
<settingsFile>src/it/settings.xml</settingsFile>
|
||||||
<localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
|
|
||||||
<postBuildHookScript>verify</postBuildHookScript>
|
<postBuildHookScript>verify</postBuildHookScript>
|
||||||
<addTestClassPath>true</addTestClassPath>
|
<addTestClassPath>true</addTestClassPath>
|
||||||
<skipInvocation>${skipTests}</skipInvocation>
|
<skipInvocation>${skipTests}</skipInvocation>
|
||||||
<streamLogs>true</streamLogs>
|
<streamLogs>true</streamLogs>
|
||||||
</configuration>
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-antrun-plugin</artifactId>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<id>integration-test</id>
|
<id>cleanup-local-integration-repo</id>
|
||||||
|
<phase>pre-integration-test</phase>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>install</goal>
|
|
||||||
<goal>run</goal>
|
<goal>run</goal>
|
||||||
</goals>
|
</goals>
|
||||||
|
<configuration>
|
||||||
|
<target>
|
||||||
|
<replaceregexp match="\$\{revision\}" replace="${project.version}"
|
||||||
|
flags="g" byline="true">
|
||||||
|
<fileset
|
||||||
|
dir="${project.build.directory}/local-repo/org/springframework/boot/"
|
||||||
|
includes="**/*.pom" />
|
||||||
|
</replaceregexp>
|
||||||
|
</target>
|
||||||
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
</executions>
|
</executions>
|
||||||
</plugin>
|
</plugin>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue