mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-07-05 00:56:58 +08:00
Update "Building reference documentation" section
This commit also changes `spring-boot-maven-plugin/pom.xml` to make it work with `full` Maven profile. Closes gh-11045
This commit is contained in:
parent
5c2d487b3e
commit
639bf5e99c
|
@ -131,7 +131,7 @@ available so you need to build that first since it's not generated by default.
|
|||
|
||||
[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
|
||||
|
@ -140,17 +140,17 @@ it:
|
|||
|
||||
[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:
|
||||
|
||||
[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
|
||||
|
|
|
@ -202,21 +202,52 @@
|
|||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-invoker-plugin</artifactId>
|
||||
<configuration>
|
||||
<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
|
||||
<settingsFile>src/it/settings.xml</settingsFile>
|
||||
<localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
|
||||
<postBuildHookScript>verify</postBuildHookScript>
|
||||
<addTestClassPath>true</addTestClassPath>
|
||||
<skipInvocation>${skipTests}</skipInvocation>
|
||||
<streamLogs>true</streamLogs>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>integration-test</id>
|
||||
<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>
|
||||
<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
|
||||
<settingsFile>src/it/settings.xml</settingsFile>
|
||||
<postBuildHookScript>verify</postBuildHookScript>
|
||||
<addTestClassPath>true</addTestClassPath>
|
||||
<skipInvocation>${skipTests}</skipInvocation>
|
||||
<streamLogs>true</streamLogs>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>cleanup-local-integration-repo</id>
|
||||
<phase>pre-integration-test</phase>
|
||||
<goals>
|
||||
<goal>run</goal>
|
||||
</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>
|
||||
</executions>
|
||||
</plugin>
|
||||
|
|
Loading…
Reference in New Issue
Block a user