Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweak documentation generation process

Browse Source 
* Update and filter distribution resources
* Use maven's `site` phase instead of `verify`
  to generate docs/distribution
This commit is contained in:
Mahmoud Ben Hassine
2020-12-17 13:55:16 +01:00
parent cde1d41b15
commit e2b37f4b4c
7 changed files with 83 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -29,6 +29,12 @@ If you want to perform a full build with all integration tests, then run:
$ ./mvnw verify
To generate the reference documentation, run:
$ ./mvnw site
The reference documentation can be found in `spring-batch-docs/target`.
## Spring Tool Suite (STS)
In STS (or any Eclipse distro or other IDE with Maven support), import the module directories as existing projects. They should compile and the tests should run with no additional steps.

22
pom.xml
View File

@@ -130,6 +130,9 @@
<asciidoctor-maven-plugin.version>2.1.0</asciidoctor-maven-plugin.version>
<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
<maven-dependency-plugin.version>3.1.2</maven-dependency-plugin.version>
<maven-site-plugin.version>3.9.1</maven-site-plugin.version>
<maven-project-info-reports-plugin.version>3.1.1</maven-project-info-reports-plugin.version>
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
</properties>
<build>
@@ -245,6 +248,11 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${maven-site-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
@@ -414,4 +422,18 @@
</roles>
</developer>
</developers>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>${maven-project-info-reports-plugin.version}</version>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</reporting>
</project>

24
spring-batch-docs/pom.xml
View File

@@ -20,7 +20,21 @@
</dependencies>
<build>
<resources>
<resource>
<directory>src/dist</directory>
<includes>
<include>*.txt</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${maven-resources-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
@@ -28,7 +42,7 @@
<executions>
<execution>
<id>unpack-resources</id>
<phase>generate-resources</phase>
<phase>pre-site</phase>
<goals>
<goal>unpack-dependencies</goal>
</goals>
@@ -60,7 +74,7 @@
<executions>
<execution>
<id>generate-html</id>
<phase>verify</phase>
<phase>site</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
@@ -87,7 +101,7 @@
</execution>
<execution>
<id>generate-pdf</id>
<phase>verify</phase>
<phase>site</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
@@ -123,8 +137,8 @@
</configuration>
<executions>
<execution>
<id>generate-docs</id>
<phase>verify</phase>
<id>create-distribution</id>
<phase>site</phase>
<goals>
<goal>single</goal>
</goals>

6
spring-batch-docs/src/assembly/dist.xml
View File

@@ -84,13 +84,13 @@
<outputDirectory>docs/reference/pdf</outputDirectory>
</file>
<file>
<source>src/dist/license.txt</source>
<source>target/classes/license.txt</source>
</file>
<file>
<source>src/dist/notice.txt</source>
<source>target/classes/notice.txt</source>
</file>
<file>
<source>src/dist/readme.txt</source>
<source>target/classes/readme.txt</source>
</file>
</files>
</assembly>

50
spring-batch-docs/src/dist/license.txt vendored
View File

@@ -212,7 +212,7 @@ code for these subcomponents is subject to the terms and
conditions of the following licenses.
>>> ASM 4.0 (org.ow2.asm:asm:4.0, org.ow2.asm:asm-commons:4.0):
>>> ASM 7.1 (org.ow2.asm:asm:7.1, org.ow2.asm:asm-commons:7.1):
Copyright (c) 2000-2011 INRIA, France Telecom
All rights reserved.
@@ -247,33 +247,43 @@ THE POSSIBILITY OF SUCH DAMAGE.
Copyright (c) 1999-2009, OW2 Consortium <https://www.ow2.org/>
>>> CGLIB 3.0 (cglib:cglib:3.0):
>>> CGLIB 3.3 (cglib:cglib:3.3):
Per the LICENSE file in the CGLIB JAR distribution downloaded from
https://sourceforge.net/projects/cglib/files/cglib3/3.0/cglib-3.0.jar/download,
CGLIB 3.0 is licensed under the Apache License, version 2.0, the text of which
https://github.com/cglib/cglib/releases/download/RELEASE_3_3_0/cglib-3.3.0.jar,
CGLIB 3.3 is licensed under the Apache License, version 2.0, the text of which
is included above.
=======================================================================
>>> Objenesis 3.1 (org.objenesis:objenesis:3.1):
To the extent any open source subcomponents are licensed under the EPL and/or
Per the LICENSE file in the Objenesis ZIP distribution downloaded from
http://objenesis.org/download.html, Objenesis 3.1 is licensed under the
Apache License, version 2.0, the text of which is included above.
Per the NOTICE file in the Objenesis ZIP distribution downloaded from
http://objenesis.org/download.html and corresponding to section 4d of the
Apache License, Version 2.0, in this case for Objenesis:
Objenesis
Copyright 2006-2019 Joe Walnes, Henri Tremblay, Leonardo Mesquita
===============================================================================
To the extent any open source components are licensed under the EPL and/or
other similar licenses that require the source code and/or modifications to
source code to be made available (as would be noted above), you may obtain a
copy of the source code corresponding to the binaries for such open source
components and modifications thereto, if any, (the "Source Files"), by
downloading the Source Files from https://www.springsource.org/download, or by
sending a request, with your name and address to:
downloading the Source Files from https://spring.io/projects, Pivotal's website
at https://network.pivotal.io/open-source, or by sending a request, with your
name and address to: Pivotal Software, Inc., 875 Howard Street, 5th floor, San
Francisco, CA 94103, Attention: General Counsel. All such requests should
clearly specify: OPEN SOURCE FILES REQUEST, Attention General Counsel. Pivotal
can mail a copy of the Source Files to you on a CD or equivalent physical
medium.
Pivotal, Inc., 875 Howard St,
San Francisco, CA 94103
United States of America
or email info@gopivotal.com. All such requests should clearly specify:
OPEN SOURCE FILES REQUEST
Attention General Counsel
Pivotal shall mail a copy of the Source Files to you on a CD or equivalent
physical medium. This offer to obtain a copy of the Source Files is valid for
three years from the date you acquired this Software product.
This offer to obtain a copy of the Source Files is valid for three years from
the date you acquired this Software product. Alternatively, the Source Files
may accompany the Software.

4
spring-batch-docs/src/dist/notice.txt vendored
View File

@@ -1,5 +1,5 @@
Spring Batch ${version}
Copyright (c) 2002-${copyright} Pivotal, Inc.
Spring Batch ${project.version}
Copyright (c) Pivotal, Inc.
This product is licensed to you under the Apache License, Version 2.0
(the "License"). You may not use this product except in compliance with

2
spring-batch-docs/src/dist/readme.txt vendored
View File

@@ -1,4 +1,4 @@
Spring Batch version ${version}
Spring Batch version ${project.version}
=====================================================================================
To find out what has changed since earlier releases, see the 'Releases' section at