diff --git a/pom.xml b/pom.xml index f2d6b99c5..856f8565c 100644 --- a/pom.xml +++ b/pom.xml @@ -154,11 +154,36 @@ ${project.basedir}/spring-batch-docs/src/main/javadoc/overview.html + + + generate-javadocs + package + + jar + + + + generate-aggregate-javadocs + package + + aggregate + + + org.apache.maven.plugins maven-source-plugin ${maven-source-plugin.version} + + + generate-sources + package + + jar + + + org.jacoco diff --git a/spring-batch-docs/pom.xml b/spring-batch-docs/pom.xml index 28bc7dbea..66e84e288 100644 --- a/spring-batch-docs/pom.xml +++ b/spring-batch-docs/pom.xml @@ -27,7 +27,7 @@ unpack-resources - site + generate-resources unpack-dependencies @@ -59,7 +59,7 @@ generate-html - site + verify process-asciidoc @@ -86,7 +86,7 @@ generate-pdf - site + verify process-asciidoc @@ -107,6 +107,29 @@ + + org.apache.maven.plugins + maven-assembly-plugin + 3.3.0 + + + src/assembly/docs.xml + src/assembly/schemas.xml + src/assembly/dist.xml + + spring-batch-${project.version} + true + + + + generate-docs + verify + + single + + + + diff --git a/spring-batch-docs/src/assembly/dist.xml b/spring-batch-docs/src/assembly/dist.xml new file mode 100644 index 000000000..e338a695e --- /dev/null +++ b/spring-batch-docs/src/assembly/dist.xml @@ -0,0 +1,96 @@ + + dist + + zip + + true + spring-batch-${project.version} + + + + target/asciidoc + docs/reference/html + + css/*.* + images/*.* + js/**/*.* + *.html + + + + ../target/site/apidocs + docs/api + + + + ../spring-batch-core/src/main/resources/org/springframework/batch/core/jsr/configuration/xml + schema/batch + + *.xsd + + + + ../spring-batch-core/src/main/resources/org/springframework/batch/core/configuration/xml + schema/batch + + *.xsd + + + + ../spring-batch-integration/src/main/resources/org/springframework/batch/integration/config/xml + schema/batch/integration + + *.xsd + + + + + ../spring-batch-core/target + libs + + *.jar + + + + ../spring-batch-infrastructure/target + libs + + *.jar + + + + ../spring-batch-test/target + libs + + *.jar + + + + ../spring-batch-integration/target + libs + + *.jar + + + + + + + + target/asciidoc/index-single.pdf + spring-batch-reference.pdf + docs/reference/pdf + + + src/dist/license.txt + + + src/dist/notice.txt + + + src/dist/readme.txt + + + \ No newline at end of file diff --git a/spring-batch-docs/src/assembly/docs.xml b/spring-batch-docs/src/assembly/docs.xml new file mode 100644 index 000000000..8cc15ad1e --- /dev/null +++ b/spring-batch-docs/src/assembly/docs.xml @@ -0,0 +1,32 @@ + + docs + + zip + + false + + + target/asciidoc + reference/html + + css/*.* + images/*.* + js/**/*.* + *.html + + + + ../target/site/apidocs + api + + + + + target/asciidoc/index-single.pdf + spring-batch-reference.pdf + reference/pdf + + + diff --git a/spring-batch-docs/src/assembly/schemas.xml b/spring-batch-docs/src/assembly/schemas.xml new file mode 100644 index 000000000..def76e180 --- /dev/null +++ b/spring-batch-docs/src/assembly/schemas.xml @@ -0,0 +1,33 @@ + + schemas + + zip + + false + + + ../spring-batch-core/src/main/resources/org/springframework/batch/core/jsr/configuration/xml + batch + + *.xsd + + + + ../spring-batch-core/src/main/resources/org/springframework/batch/core/configuration/xml + batch + + *.xsd + + + + ../spring-batch-integration/src/main/resources/org/springframework/batch/integration/config/xml + batch/integration + + *.xsd + + + + + diff --git a/src/dist/license.txt b/spring-batch-docs/src/dist/license.txt similarity index 100% rename from src/dist/license.txt rename to spring-batch-docs/src/dist/license.txt diff --git a/src/dist/notice.txt b/spring-batch-docs/src/dist/notice.txt similarity index 100% rename from src/dist/notice.txt rename to spring-batch-docs/src/dist/notice.txt diff --git a/src/dist/readme.txt b/spring-batch-docs/src/dist/readme.txt similarity index 67% rename from src/dist/readme.txt rename to spring-batch-docs/src/dist/readme.txt index 56311d7f8..0d6c69418 100644 --- a/src/dist/readme.txt +++ b/spring-batch-docs/src/dist/readme.txt @@ -4,11 +4,11 @@ Spring Batch version ${version} To find out what has changed since earlier releases, see the 'Releases' section at https://github.com/spring-projects/spring-batch/releases -Please consult the documentation located within the 'docs/spring-batch-reference' +Please consult the documentation located within the 'docs/reference' directory of this release and also visit the official Spring Batch home at https://projects.spring.io/spring-batch/ -There you will find links to the forum, issue tracker, and other resources. +There you will find links to the documentation, issue tracker, and other resources. See https://github.com/spring-projects/spring-batch#readme for additional -information including instructions on building from source. +information including instructions on building from source code. diff --git a/src/ant/upload-dist.xml b/src/ant/upload-dist.xml deleted file mode 100644 index 20f49a662..000000000 --- a/src/ant/upload-dist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Copying dist .ZIP to ${dist.staging} - - - - - diff --git a/src/assembly/docs.xml b/src/assembly/docs.xml deleted file mode 100644 index 463c72556..000000000 --- a/src/assembly/docs.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - src/assembly - - - license.txt - notice.txt - - - - . - - - README.md - - - - diff --git a/src/assembly/license.txt b/src/assembly/license.txt deleted file mode 100644 index 20e4bd856..000000000 --- a/src/assembly/license.txt +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - https://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - https://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/src/assembly/no-dependencies.xml b/src/assembly/no-dependencies.xml deleted file mode 100644 index 0138b4783..000000000 --- a/src/assembly/no-dependencies.xml +++ /dev/null @@ -1,83 +0,0 @@ - - no-dependencies - - zip - - - src/assembly/docs.xml - - true - - - - - org.springframework.batch:spring-batch-parent - - - org.springframework.batch:spring-batch-test - - - org.springframework.batch:spring-batch-core - - - org.springframework.batch:spring-batch-infrastructure - - - - false - - - target - dist - - *.jar - - - - - - - - - org.springframework.batch:spring-batch-samples - - - org.springframework.batch:spring-batch-simple-cli - - - - - samples/${module.artifactId} - - - - - bin/** - target/** - - - - - - - - - org.springframework.batch:spring-batch-parent - - - - - samples/spring-batch-parent - - - - - bin/** - target/** - - - - - - - diff --git a/src/assembly/notice.txt b/src/assembly/notice.txt deleted file mode 100644 index 38732336c..000000000 --- a/src/assembly/notice.txt +++ /dev/null @@ -1,21 +0,0 @@ - ====================================================================== - == NOTICE file corresponding to section 4 d of the Apache License, == - == Version 2.0, in this case for the Spring Framework distribution. == - ====================================================================== - - This product includes software developed by - the Apache Software Foundation (https://www.apache.org). - - The end-user documentation included with a redistribution, if any, - must include the following acknowledgement: - - "This product includes software developed by the Spring Framework - Project (https://www.spring.io)." - - Alternatively, this acknowledgement may appear in the software itself, - if and wherever such third-party acknowledgements normally appear. - - The names "Spring" and "Spring Framework" must not be used to - endorse or promote products derived from this software without - prior written permission. For written permission, please contact - rod.johnson@interface21.com or juergen.hoeller@interface21.com.