Commit a6f16199 authored by Andy Wilkinson's avatar Andy Wilkinson

Use Asciidoctor extension to verify documented configuration properties

Closes gh-18451
parent a36d2cd1
...@@ -1522,8 +1522,31 @@ ...@@ -1522,8 +1522,31 @@
<spring-framework-version>${spring-framework.version}</spring-framework-version> <spring-framework-version>${spring-framework.version}</spring-framework-version>
<spring-integration-version>${spring-integration.version}</spring-integration-version> <spring-integration-version>${spring-integration.version}</spring-integration-version>
<spring-security-version>${spring-security.version}</spring-security-version> <spring-security-version>${spring-security.version}</spring-security-version>
<spring-webservices-version>${spring-ws.version}</spring-webservices-version> </attributes> <spring-webservices-version>${spring-ws.version}</spring-webservices-version>
</attributes>
</configuration> </configuration>
<dependencies>
<dependency>
<groupId>io.spring.asciidoctor</groupId>
<artifactId>spring-asciidoctor-extensions-spring-boot</artifactId>
<version>${spring-asciidoctor-extensions.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator-autoconfigure</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<version>${revision}</version>
</dependency>
</dependencies>
<executions> <executions>
<execution> <execution>
<id>generate-html-documentation</id> <id>generate-html-documentation</id>
...@@ -1551,9 +1574,9 @@ ...@@ -1551,9 +1574,9 @@
<attribute-missing>warn</attribute-missing> <attribute-missing>warn</attribute-missing>
</attributes> </attributes>
<logHandler> <logHandler>
<outputToConsole>true</outputToConsole> <outputToConsole>false</outputToConsole>
<failIf> <failIf>
<severity>DEBUG</severity> <severity>INFO</severity>
</failIf> </failIf>
</logHandler> </logHandler>
</configuration> </configuration>
...@@ -1581,6 +1604,12 @@ ...@@ -1581,6 +1604,12 @@
<stylesdir>css/</stylesdir> <stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet> <stylesheet>spring.css</stylesheet>
</attributes> </attributes>
<logHandler>
<outputToConsole>false</outputToConsole>
<failIf>
<severity>INFO</severity>
</failIf>
</logHandler>
</configuration> </configuration>
</execution> </execution>
<execution> <execution>
......
...@@ -81,7 +81,7 @@ They use a simple JSON format with items categorized under either "`groups`" or ...@@ -81,7 +81,7 @@ They use a simple JSON format with items categorized under either "`groups`" or
Each "`property`" is a configuration item that the user specifies with a given value. Each "`property`" is a configuration item that the user specifies with a given value.
For example, `server.port` and `server.address` might be specified in `application.properties`, as follows: For example, `server.port` and `server.address` might be specified in `application.properties`, as follows:
[source,properties,indent=0] [source,properties,indent=0,configprops]
---- ----
server.port=9090 server.port=9090
server.address=127.0.0.1 server.address=127.0.0.1
...@@ -94,7 +94,7 @@ NOTE: It is not required that every "`property`" has a "`group`". ...@@ -94,7 +94,7 @@ NOTE: It is not required that every "`property`" has a "`group`".
Some properties might exist in their own right. Some properties might exist in their own right.
Finally, "`hints`" are additional information used to assist the user in configuring a given property. Finally, "`hints`" are additional information used to assist the user in configuring a given property.
For example, when a developer is configuring the `spring.jpa.hibernate.ddl-auto` property, a tool can use the hints to offer some auto-completion help for the `none`, `validate`, `update`, `create`, and `create-drop` values. For example, when a developer is configuring the configprop:spring.jpa.hibernate.ddl-auto[] property, a tool can use the hints to offer some auto-completion help for the `none`, `validate`, `update`, `create`, and `create-drop` values.
......
...@@ -26,10 +26,11 @@ ...@@ -26,10 +26,11 @@
<maven.version>3.5.4</maven.version> <maven.version>3.5.4</maven.version>
<maven-resolver.version>1.1.1</maven-resolver.version> <maven-resolver.version>1.1.1</maven-resolver.version>
<spock.version>1.0-groovy-2.4</spock.version> <spock.version>1.0-groovy-2.4</spock.version>
<testcontainers.version>1.12.2</testcontainers.version> <spring-asciidoctor-extensions.version>0.3.0.BUILD-SNAPSHOT</spring-asciidoctor-extensions.version>
<testng.version>6.14.3</testng.version>
<spring-doc-resources.version>0.1.3.RELEASE</spring-doc-resources.version> <spring-doc-resources.version>0.1.3.RELEASE</spring-doc-resources.version>
<spring-doc-resources.url>https://repo.spring.io/release/io/spring/docresources/spring-doc-resources/${spring-doc-resources.version}/spring-doc-resources-${spring-doc-resources.version}.zip</spring-doc-resources.url> <spring-doc-resources.url>https://repo.spring.io/release/io/spring/docresources/spring-doc-resources/${spring-doc-resources.version}/spring-doc-resources-${spring-doc-resources.version}.zip</spring-doc-resources.url>
<testcontainers.version>1.12.2</testcontainers.version>
<testng.version>6.14.3</testng.version>
</properties> </properties>
<scm> <scm>
<url>https://github.com/spring-projects/spring-boot</url> <url>https://github.com/spring-projects/spring-boot</url>
......
...@@ -360,7 +360,7 @@ ...@@ -360,7 +360,7 @@
<dependency> <dependency>
<groupId>io.spring.asciidoctor</groupId> <groupId>io.spring.asciidoctor</groupId>
<artifactId>spring-asciidoctor-extensions</artifactId> <artifactId>spring-asciidoctor-extensions</artifactId>
<version>0.2.0.RELEASE</version> <version>${spring-asciidoctor-extensions.version}</version>
</dependency> </dependency>
</dependencies> </dependencies>
</plugin> </plugin>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment