SpringCloud/spring-cloud-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Describes how to attach the zip with docs

Browse Source
This commit is contained in:
Marcin Grzejszczak
2020-04-01 10:18:50 +02:00
parent 3b444ac772
commit aa8e68f719
3 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.adoc
View File

@@ -282,6 +282,10 @@ approach of generating documentation just add these plugins to your `docs` modul
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId> <6>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId> <7>
</plugin>
</plugins>
</build>
</profile>
@@ -293,6 +297,7 @@ approach of generating documentation just add these plugins to your `docs` modul
<4> This plugin generates an `adoc` file with all the configuration properties from the classpath
<5> This plugin is required to parse the Asciidoctor documentation
<6> This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links
<7> This plugin ensures that the generated zip docs are attached as an artifact and will get published
IMPORTANT: The order of plugin declaration is important!

7
docs/src/main/asciidoc/README.adoc
View File

@@ -98,6 +98,10 @@ approach of generating documentation just add these plugins to your `docs` modul
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId> <6>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId> <7>
</plugin>
</plugins>
</build>
</profile>
@@ -109,6 +113,7 @@ approach of generating documentation just add these plugins to your `docs` modul
<4> This plugin generates an `adoc` file with all the configuration properties from the classpath
<5> This plugin is required to parse the Asciidoctor documentation
<6> This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links
<7> This plugin ensures that the generated zip docs are attached as an artifact and will get published
IMPORTANT: The order of plugin declaration is important!
@@ -152,4 +157,4 @@ what will happen is that for GA project versions, we will clone `gs-guide1`, `gs
You can skip this by either not adding the `guides` profile, or passing the `-DskipGuides` system property when the profile is turned on.
You can configure the project version passed to guides via the `guides-project.version` (defaults to `${project.version}`). The phase at which guides get updated can be configured by `guides-update.phase` (defaults to `deploy`).
You can configure the project version passed to guides via the `guides-project.version` (defaults to `${project.version}`). The phase at which guides get updated can be configured by `guides-update.phase` (defaults to `deploy`).

2
pom.xml
View File

@@ -1373,10 +1373,10 @@
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>${build-helper-maven-plugin.version}</version>
<inherited>false</inherited>
<executions>
<execution>
<id>attach-zip</id>
<phase>package</phase>
<goals>
<goal>attach-artifact</goal>
</goals>