= Spring Cloud Stream & Task Maven Documentation Plugin
Maven plugin for generating documentation for https://github.com/spring-cloud/stream-applications[Spring Cloud Stream Applications].
Assuming a Spring Cloud Stream / Spring Cloud Task app has exposed application properties to be visible (i.e. provided a https://dataflow.spring.io/docs/applications/application-metadata/#exposing-application-properties-for-data-flow[dataflow-configuration-metadata.properties]), this plugin will help generate documentation for the properties.
== Usage
To use this plugin, simply add the following markers to your project `README.adoc` file:
[source, properties]
----
//tag::configuration-properties[]
//end::configuration-properties[]
----
Then, configure this plugin for your app project (either directly or through a parent POM):
[source, xml]
----
<build>
<plugins>
<plugin>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dataflow-apps-docs-plugin</artifactId>
<version>1.1.0-SNAPSHOT</version>
<executions>
<execution>
<id>generate-documentation</id>
<phase>verify</phase>
<goals>
<goal>generate-documentation</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
----
Documentation for the visible properties shall appear on next build, which should then be committed to source control.
