diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index be447de8..00000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,39 +0,0 @@ -version: 2 -jobs: - build: - docker: - - image: springcloud/pipeline-base - user: appuser - environment: - _JAVA_OPTIONS: "-Xms1024m -Xmx2048m" - TERM: dumb - branches: - ignore: - - gh-pages # list of branches to ignore - steps: - - checkout - - restore_cache: - key: sc-release-{{ .Branch }} - - run: - name: "Download dependencies" - command: ./mvnw -s .settings.xml -U --fail-never dependency:go-offline || true - - save_cache: - key: sc-release-{{ .Branch }} - paths: - - ~/.m2 - - run: - name: "Running build" - command: ./mvnw -s .settings.xml clean org.jacoco:jacoco-maven-plugin:prepare-agent install -U -P sonar -nsu --batch-mode -Dmaven.test.redirectTestOutputToFile=true -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn - - run: - name: "Aggregate test results" - when: always - command: | - mkdir -p ~/junit/ - find . -type f -regex ".*/target/.*-reports/.*" -exec cp {} ~/junit/ \; - bash <(curl -s https://codecov.io/bash) - - store_artifacts: - path: ~/junit/ - destination: artifacts - - store_test_results: - path: ~/junit/ - destination: testartifacts \ No newline at end of file diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index ddda9782..00000000 --- a/.editorconfig +++ /dev/null @@ -1,24 +0,0 @@ -root = true - -[*.java] -indent_style = tab -indent_size = 4 -continuation_indent_size = 8 - -[*.groovy] -indent_style = tab -indent_size = 4 -continuation_indent_size = 8 - -[*.xml] -indent_style = tab -indent_size = 4 -continuation_indent_size = 8 - -[*.yml] -indent_style = space -indent_size = 2 - -[*.yaml] -indent_style = space -indent_size = 2 diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index eb9a16ae..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Contributing - -Spring Cloud is released under the non-restrictive Apache 2.0 license, -and follows a very standard Github development process, using Github -tracker for issues and merging pull requests into master. If you want -to contribute even something trivial please do not hesitate, but -follow the guidelines below. - -## Sign the Contributor License Agreement -Before we accept a non-trivial patch or pull request we will need you to sign the -[Contributor License Agreement](https://cla.pivotal.io/sign/spring). -Signing the contributor's agreement does not grant anyone commit rights to the main -repository, but it does mean that we can accept your contributions, and you will get an -author credit if we do. Active contributors might be asked to join the core team, and -given the ability to merge pull requests. - -## Code of Conduct -This project adheres to the Contributor Covenant [code of -conduct](https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report -unacceptable behavior to spring-code-of-conduct@pivotal.io. - -## Code Conventions and Housekeeping -None of these is essential for a pull request, but they will all help. They can also be -added after the original pull request but before a merge. - -* Use the Spring Framework code format conventions. If you use Eclipse - you can import formatter settings using the - `eclipse-code-formatter.xml` file from the - [Spring Cloud Build](https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml) project. If using IntelliJ, you can use the - [Eclipse Code Formatter Plugin](https://plugins.jetbrains.com/plugin/6546) to import the same file. -* Make sure all new `.java` files to have a simple Javadoc class comment with at least an - `@author` tag identifying you, and preferably at least a paragraph on what the class is - for. -* Add the ASF license header comment to all new `.java` files (copy from existing files - in the project) -* Add yourself as an `@author` to the .java files that you modify substantially (more - than cosmetic changes). -* Add some Javadocs and, if you change the namespace, some XSD doc elements. -* A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or - other target branch in the main project). -* When writing a commit message please follow [these conventions](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), - if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 0bc5ef4f..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index aeafef9d..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -Please provide details of the problem, including the version of Spring Cloud that you -are using. - -**Sample** -If possible, please provide a test case or sample application that reproduces -the problem. This makes it much easier for us to diagnose the problem and to verify that -we have fixed it. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..5775c3a0 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,53 @@ +name: Deploy Docs +run-name: ${{ format('{0} ({1})', github.workflow, github.event.inputs.build-refname || 'all') }} +on: + workflow_dispatch: + inputs: + build-refname: + description: Enter git refname to build (e.g., 5.7.x). + required: false + push: + branches: docs-build +env: + GRADLE_ENTERPRISE_SECRET_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }} +permissions: + contents: write +jobs: + build: + if: github.repository_owner == 'spring-cloud' + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 5 + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + - name: Set up refname build + if: github.event.inputs.build-refname + run: | + git fetch --depth 1 https://github.com/$GITHUB_REPOSITORY ${{ github.event.inputs.build-refname }} + export BUILD_REFNAME=${{ github.event.inputs.build-refname }} + echo "BUILD_REFNAME=$BUILD_REFNAME" >> $GITHUB_ENV + export BUILD_VERSION=$(git cat-file --textconv FETCH_HEAD:pom.xml | python3 -c "import xml.etree.ElementTree as xml; from sys import stdin; print(xml.parse(stdin).getroot().find('{http://maven.apache.org/POM/4.0.0}version').text)") + echo BUILD_VERSION=$BUILD_VERSION >> $GITHUB_ENV + - name: Run Antora + run: | + ./mvnw --no-transfer-progress -B antora -Pdocs + - name: Publish Docs + uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.13 + with: + docs-username: ${{ secrets.DOCS_USERNAME }} + docs-host: ${{ secrets.DOCS_HOST }} + docs-ssh-key: ${{ secrets.DOCS_SSH_KEY }} + docs-ssh-host-key: ${{ secrets.DOCS_SSH_HOST_KEY }} + site-path: target/antora/site + - name: Bust Cloudflare Cache + uses: spring-io/spring-doc-actions/bust-cloudflare-antora-cache@v0.0.11 + with: + context-root: spring-cloud-release + cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }} + cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }} diff --git a/.gitignore b/.gitignore index 4bb61be1..a7e66892 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,28 @@ -*~ -#* -*# -.#* -.classpath +target/ +.settings/ .project -.settings +.classpath +*.orig .springBeans -.gradle -build -bin -target/ -.idea +.factorypath +.sts4-cache +.ant-targets-build.xml +src/ant/.ant-targets-upload-dist.xml +*.sonar4clipse* +.DS_Store *.iml *.ipr *.iws -.factorypath +/.idea/ +*.graphml +.vscode +node +node_modules +build +_configprops.adoc +_spans.adoc +_metrics.adoc +_conventions.adoc +docs/package.json +package-lock.json .flattened-pom.xml diff --git a/.mvn/maven.config b/.mvn/maven.config deleted file mode 100644 index 3b8cf46e..00000000 --- a/.mvn/maven.config +++ /dev/null @@ -1 +0,0 @@ --DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local -P spring diff --git a/.sdkmanrc b/.sdkmanrc deleted file mode 100644 index 415f9083..00000000 --- a/.sdkmanrc +++ /dev/null @@ -1,3 +0,0 @@ -# Enable auto-env through the sdkman_auto_env config -# Add key=value pairs of SDKs to use below -java=17.0.1-tem diff --git a/.settings.xml b/.settings.xml deleted file mode 100644 index 03645e8c..00000000 --- a/.settings.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - repo.spring.io - ${env.CI_DEPLOY_USERNAME} - ${env.CI_DEPLOY_PASSWORD} - - - - - - spring - - true - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - diff --git a/.springformat b/.springformat deleted file mode 100644 index e69de29b..00000000 diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 62589edd..00000000 --- a/LICENSE.txt +++ /dev/null @@ -1,202 +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/README.adoc b/README.adoc index 63a60907..02299ff9 100644 --- a/README.adoc +++ b/README.adoc @@ -1,292 +1,23 @@ -//// -DO NOT EDIT THIS FILE. IT WAS GENERATED. -Manual changes to this file will be lost when it is generated again. -Edit the files in the src/main/asciidoc/ directory instead. -//// += Spring Cloud Release Docs Build +You're currently viewing the Antora playbook branch. +The playbook branch hosts the docs build that is used to build and publish the production docs site. -Spring Cloud Release Train is a curated set of dependencies across a -range of Spring Cloud projects. You consume it by using the -spring-cloud-dependencies POM to manage dependencies in Maven or -Gradle. The release trains have names, not versions, to avoid -confusion with the sub-projects. The names are an alphabetic sequence -(so you can sort them chronologically) with names of London Tube -stations ("Angel" is the first release, "Brixton" is the second). +The Spring Cloud Release reference docs are built using https://antora.org[Antora]. +This README covers how to build the docs in a software branch as well as how to build the production docs site locally. -== Generating release train documentation +== Building the Site -In order to generate the release train documentation, please update the project with versions for a given release train and then execute the following command: +You can build the entire site by invoking the following on the docs-build branch and then viewing the site at `target/site/index.html` -```bash -$ ./mvnw clean install -Pdocs,train-docs -pl train-docs -``` - -In order to upload the documentation to the documentation server just execute the following command: - -```bash -$ ./mvnw clean deploy -Pdocs,train-docs -pl train-docs -``` - -IMPORTANT: If you're releasing milestones don't forget to add `-Pmilestone` and if GA `-Pcentral`. - -== Contributing - -:spring-cloud-build-branch: master - -Spring Cloud is released under the non-restrictive Apache 2.0 license, -and follows a very standard Github development process, using Github -tracker for issues and merging pull requests into master. If you want -to contribute even something trivial please do not hesitate, but -follow the guidelines below. - -=== Sign the Contributor License Agreement -Before we accept a non-trivial patch or pull request we will need you to sign the -https://cla.pivotal.io/sign/spring[Contributor License Agreement]. -Signing the contributor's agreement does not grant anyone commit rights to the main -repository, but it does mean that we can accept your contributions, and you will get an -author credit if we do. Active contributors might be asked to join the core team, and -given the ability to merge pull requests. - -=== Code of Conduct -This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of -conduct]. By participating, you are expected to uphold this code. Please report -unacceptable behavior to spring-code-of-conduct@pivotal.io. - -=== Code Conventions and Housekeeping -None of these is essential for a pull request, but they will all help. They can also be -added after the original pull request but before a merge. - -* Use the Spring Framework code format conventions. If you use Eclipse - you can import formatter settings using the - `eclipse-code-formatter.xml` file from the - https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring - Cloud Build] project. If using IntelliJ, you can use the - https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter - Plugin] to import the same file. -* Make sure all new `.java` files to have a simple Javadoc class comment with at least an - `@author` tag identifying you, and preferably at least a paragraph on what the class is - for. -* Add the ASF license header comment to all new `.java` files (copy from existing files - in the project) -* Add yourself as an `@author` to the .java files that you modify substantially (more - than cosmetic changes). -* Add some Javadocs and, if you change the namespace, some XSD doc elements. -* A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or - other target branch in the main project). -* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], - if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). - -=== Checkstyle - -Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: - -.spring-cloud-build-tools/ ----- -└── src -    ├── checkstyle -    │   └── checkstyle-suppressions.xml <3> -    └── main -    └── resources -    ├── checkstyle-header.txt <2> -    └── checkstyle.xml <1> ----- -<1> Default Checkstyle rules -<2> File header setup -<3> Default suppression rules - -==== Checkstyle configuration - -Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. - -.pom.xml ----- - -true <1> - true - <2> - true - <3> - - - - - <4> - io.spring.javaformat - spring-javaformat-maven-plugin - - <5> - org.apache.maven.plugins - maven-checkstyle-plugin - - - - - - <5> - org.apache.maven.plugins - maven-checkstyle-plugin - - - - ----- -<1> Fails the build upon Checkstyle errors -<2> Fails the build upon Checkstyle violations -<3> Checkstyle analyzes also the test sources -<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules -<5> Add checkstyle plugin to your build and reporting phases - -If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example: - -.projectRoot/src/checkstyle/checkstyle-suppresions.xml +[source,bash] ---- - - - - - - +mvn antora ---- -It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: +== Building a Specific Branch -```bash -$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig -$ touch .springformat -``` - -=== IDE setup - -==== Intellij IDEA - -In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. -The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project. - -.spring-cloud-build-tools/ +[source,bash] ---- -└── src -    ├── checkstyle -    │   └── checkstyle-suppressions.xml <3> -    └── main -    └── resources -    ├── checkstyle-header.txt <2> -    ├── checkstyle.xml <1> -    └── intellij -       ├── Intellij_Project_Defaults.xml <4> -       └── Intellij_Spring_Boot_Java_Conventions.xml <5> +mvn antora ---- -<1> Default Checkstyle rules -<2> File header setup -<3> Default suppression rules -<4> Project defaults for Intellij that apply most of Checkstyle rules -<5> Project style conventions for Intellij that apply most of Checkstyle rules - -.Code style - -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style] - -Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. - -.Inspection profiles - -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style] - -Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. - -.Checkstyle - -To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions - -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle] - -Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: - -- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. -- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. -- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. - -IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. - -=== Duplicate Finder - -Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath. - -==== Duplicate Finder configuration - -Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`. - -.pom.xml -[source,xml] ----- - - - - org.basepom.maven - duplicate-finder-maven-plugin - - - ----- - -For other properties, we have set defaults as listed in the https://github.com/basepom/duplicate-finder-maven-plugin/wiki[plugin documentation]. - -You can easily override them but setting the value of the selected property prefixed with `duplicate-finder-maven-plugin`. For example, set `duplicate-finder-maven-plugin.skip` to `true` in order to skip duplicates check in your build. - -If you need to add `ignoredClassPatterns` or `ignoredResourcePatterns` to your setup, make sure to add them in the plugin configuration section of your project: - -[source,xml] ----- - - - - org.basepom.maven - duplicate-finder-maven-plugin - - - org.joda.time.base.BaseDateTime - .*module-info - - - changelog.txt - - - - - - - ----- - - -== Building and Deploying - -Since there is no code to compile in the starters they should do not need to compile, but a compiler has to be available because they are built and deployed as JAR artifacts. To install locally: - ----- - -$ mvn install -s .settings.xml ----- - -and to deploy snapshots to repo.spring.io: - ----- -$ mvn install -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local ----- - -for a RELEASE build use - ----- -$ mvn install -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-release-local ----- - -and for Maven Central use - ----- -$ mvn install -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2 ----- - -(the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent). diff --git a/antora-playbook.yml b/antora-playbook.yml new file mode 100644 index 00000000..3c2d8b53 --- /dev/null +++ b/antora-playbook.yml @@ -0,0 +1,41 @@ +antora: + extensions: + - require: '@springio/antora-extensions' + root_component_name: 'cloud-release' +site: + title: Spring Cloud Release + url: https://docs.spring.io/spring-cloud-release/reference + robots: allow +git: + ensure_git_suffix: false +content: + sources: + - url: https://github.com/spring-cloud/spring-cloud-release + # Refname matching: + # https://docs.antora.org/antora/latest/playbook/content-refname-matching/ + branches: [ main, 2025.0.x ] + # 20[3-9][0-9].[0-9].[0-9] + # 202[3-9].[0-9].[0-9] without 2023.0.0-M1 + tags: [ 'v20{2..9}+({0..9}).+({0..9}).+({0..9})?(-{RC,M}*)', '!v2023.0.0-M1', '!v2022.0.*', '!v2020.0.*', '!v2021.0.*' ] + start_path: docs +asciidoc: + attributes: + page-stackoverflow-url: https://stackoverflow.com/tags/spring-cloud + page-pagination: '' + hide-uri-scheme: '@' + tabs-sync-option: '@' + extensions: + - '@asciidoctor/tabs' + - '@springio/asciidoctor-extensions' +urls: + latest_version_segment_strategy: redirect:to + latest_version_segment: '' + redirect_facility: httpd +ui: + bundle: + url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.18/ui-bundle.zip + snapshot: true +runtime: + log: + failure_level: warn + format: pretty diff --git a/docs/pom.xml b/docs/pom.xml deleted file mode 100644 index 5dc05354..00000000 --- a/docs/pom.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - 4.0.0 - spring-cloud-starter-docs - - org.springframework.cloud - spring-cloud-starter-build - 2023.0.0-SNAPSHOT - - pom - Spring Cloud Starter Docs - Spring Cloud Docs - - spring-cloud-starters - ${basedir}/.. - deploy - - - - docs - - - - pl.project13.maven - git-commit-id-plugin - - - maven-dependency-plugin - - - maven-resources-plugin - - - org.codehaus.mojo - exec-maven-plugin - - - org.asciidoctor - asciidoctor-maven-plugin - - - maven-antrun-plugin - - - maven-deploy-plugin - - - - - - diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc deleted file mode 100644 index bdda3668..00000000 --- a/docs/src/main/asciidoc/README.adoc +++ /dev/null @@ -1,34 +0,0 @@ -include::intro.adoc[] - -== Contributing - -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] - -== Building and Deploying - -Since there is no code to compile in the starters they should do not need to compile, but a compiler has to be available because they are built and deployed as JAR artifacts. To install locally: - ----- - -$ mvn install -s .settings.xml ----- - -and to deploy snapshots to repo.spring.io: - ----- -$ mvn install -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local ----- - -for a RELEASE build use - ----- -$ mvn install -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-release-local ----- - -and for Maven Central use - ----- -$ mvn install -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2 ----- - -(the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent). diff --git a/docs/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh deleted file mode 100755 index f051e693..00000000 --- a/docs/src/main/asciidoc/ghpages.sh +++ /dev/null @@ -1,330 +0,0 @@ -#!/bin/bash -x - -set -e - -# Set default props like MAVEN_PATH, ROOT_FOLDER etc. -function set_default_props() { - # The script should be executed from the root folder - ROOT_FOLDER=`pwd` - echo "Current folder is ${ROOT_FOLDER}" - - if [[ ! -e "${ROOT_FOLDER}/.git" ]]; then - echo "You're not in the root folder of the project!" - exit 1 - fi - - # Prop that will let commit the changes - COMMIT_CHANGES="no" - MAVEN_PATH=${MAVEN_PATH:-} - echo "Path to Maven is [${MAVEN_PATH}]" - REPO_NAME=${PWD##*/} - echo "Repo name is [${REPO_NAME}]" - SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git} - echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}" -} - -# Check if gh-pages exists and docs have been built -function check_if_anything_to_sync() { - git remote set-url --push origin `git config remote.origin.url | sed -e 's/^git:/https:/'` - - if ! (git remote set-branches --add origin gh-pages && git fetch -q); then - echo "No gh-pages, so not syncing" - exit 0 - fi - - if ! [ -d docs/target/generated-docs ] && ! [ "${BUILD}" == "yes" ]; then - echo "No gh-pages sources in docs/target/generated-docs, so not syncing" - exit 0 - fi -} - -function retrieve_current_branch() { - # Code getting the name of the current branch. For master we want to publish as we did until now - # https://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch - # If there is a branch already passed will reuse it - otherwise will try to find it - CURRENT_BRANCH=${BRANCH} - if [[ -z "${CURRENT_BRANCH}" ]] ; then - CURRENT_BRANCH=$(git symbolic-ref -q HEAD) - CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/} - CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD} - fi - echo "Current branch is [${CURRENT_BRANCH}]" - git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" -} - -# Switches to the provided value of the release version. We always prefix it with `v` -function switch_to_tag() { - git checkout v${VERSION} -} - -# Build the docs if switch is on -function build_docs_if_applicable() { - if [[ "${BUILD}" == "yes" ]] ; then - ./mvnw clean install -P docs -pl docs -DskipTests - fi -} - -# Get the name of the `docs.main` property -# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile -function retrieve_doc_properties() { - MAIN_ADOC_VALUE=$("${MAVEN_PATH}"mvn -q \ - -Dexec.executable="echo" \ - -Dexec.args='${docs.main}' \ - --non-recursive \ - org.codehaus.mojo:exec-maven-plugin:1.3.1:exec) - echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]" - - - WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} - WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ - -Dexec.executable="echo" \ - -Dexec.args="\${${WHITELIST_PROPERTY}}" \ - org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ - -P docs \ - -pl docs) - echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_VALUE}]" -} - -# Stash any outstanding changes -function stash_changes() { - git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it is." && dirty="1") - if [ "$dirty" != "0" ]; then git stash; fi -} - -# Switch to gh-pages branch to sync it with current branch -function add_docs_from_target() { - local DESTINATION_REPO_FOLDER - if [[ -z "${DESTINATION}" && -z "${CLONE}" ]] ; then - DESTINATION_REPO_FOLDER=${ROOT_FOLDER} - elif [[ "${CLONE}" == "yes" ]]; then - mkdir -p ${ROOT_FOLDER}/target - local clonedStatic=${ROOT_FOLDER}/target/spring-cloud-static - if [[ ! -e "${clonedStatic}/.git" ]]; then - echo "Cloning Spring Cloud Static to target" - git clone ${SPRING_CLOUD_STATIC_REPO} ${clonedStatic} && git checkout gh-pages - else - echo "Spring Cloud Static already cloned - will pull changes" - cd ${clonedStatic} && git checkout gh-pages && git pull origin gh-pages - fi - DESTINATION_REPO_FOLDER=${clonedStatic}/${REPO_NAME} - mkdir -p ${DESTINATION_REPO_FOLDER} - else - if [[ ! -e "${DESTINATION}/.git" ]]; then - echo "[${DESTINATION}] is not a git repository" - exit 1 - fi - DESTINATION_REPO_FOLDER=${DESTINATION}/${REPO_NAME} - mkdir -p ${DESTINATION_REPO_FOLDER} - echo "Destination was provided [${DESTINATION}]" - fi - cd ${DESTINATION_REPO_FOLDER} - git checkout gh-pages - git pull origin gh-pages - - # Add git branches - ################################################################### - if [[ -z "${VERSION}" ]] ; then - copy_docs_for_current_version - else - copy_docs_for_provided_version - fi - commit_changes_if_applicable -} - - -# Copies the docs by using the retrieved properties from Maven build -function copy_docs_for_current_version() { - if [[ "${CURRENT_BRANCH}" == "master" ]] ; then - echo -e "Current branch is master - will copy the current docs only to the root folder" - for f in docs/target/generated-docs/*; do - file=${f#docs/target/generated-docs/*} - if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then - # Not ignored... - cp -rf $f ${ROOT_FOLDER}/ - git add -A ${ROOT_FOLDER}/$file - fi - done - COMMIT_CHANGES="yes" - else - echo -e "Current branch is [${CURRENT_BRANCH}]" - # https://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin - if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then - mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH} - echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder" - for f in docs/target/generated-docs/*; do - file=${f#docs/target/generated-docs/*} - if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then - # Not ignored... - # We want users to access 1.0.0.BUILD-SNAPSHOT/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html - if [[ "${file}" == "${MAIN_ADOC_VALUE}.html" ]] ; then - # We don't want to copy the spring-cloud-sleuth.html - # we want it to be converted to index.html - cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html - git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html - else - cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH} - git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/$file - fi - fi - done - COMMIT_CHANGES="yes" - else - echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in - [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." - fi - fi -} - -# Copies the docs by using the explicitly provided version -function copy_docs_for_provided_version() { - local FOLDER=${DESTINATION_REPO_FOLDER}/${VERSION} - mkdir -p ${FOLDER} - echo -e "Current tag is [v${VERSION}] Will copy the current docs to the [${FOLDER}] folder" - for f in ${ROOT_FOLDER}/docs/target/generated-docs/*; do - file=${f#${ROOT_FOLDER}/docs/target/generated-docs/*} - copy_docs_for_branch ${file} ${FOLDER} - done - COMMIT_CHANGES="yes" - CURRENT_BRANCH="v${VERSION}" -} - -# Copies the docs from target to the provided destination -# Params: -# $1 - file from target -# $2 - destination to which copy the files -function copy_docs_for_branch() { - local file=$1 - local destination=$2 - if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then - # Not ignored... - # We want users to access 1.0.0.BUILD-SNAPSHOT/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html - if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then - # We don't want to copy the spring-cloud-sleuth.html - # we want it to be converted to index.html - cp -rf $f ${destination}/index.html - git add -A ${destination}/index.html - else - cp -rf $f ${destination} - git add -A ${destination}/$file - fi - fi -} - -function commit_changes_if_applicable() { - if [[ "${COMMIT_CHANGES}" == "yes" ]] ; then - COMMIT_SUCCESSFUL="no" - git commit -a -m "Sync docs from ${CURRENT_BRANCH} to gh-pages" && COMMIT_SUCCESSFUL="yes" || echo "Failed to commit changes" - - # Uncomment the following push if you want to auto push to - # the gh-pages branch whenever you commit to master locally. - # This is a little extreme. Use with care! - ################################################################### - if [[ "${COMMIT_SUCCESSFUL}" == "yes" ]] ; then - git push origin gh-pages - fi - fi -} - -# Switch back to the previous branch and exit block -function checkout_previous_branch() { - # If -version was provided we need to come back to root project - cd ${ROOT_FOLDER} - git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" - if [ "$dirty" != "0" ]; then git stash pop; fi - exit 0 -} - -# Assert if properties have been properly passed -function assert_properties() { -echo "VERSION [${VERSION}], DESTINATION [${DESTINATION}], CLONE [${CLONE}]" -if [[ "${VERSION}" != "" && (-z "${DESTINATION}" && -z "${CLONE}") ]] ; then echo "Version was set but destination / clone was not!"; exit 1;fi -if [[ ("${DESTINATION}" != "" && "${CLONE}" != "") && -z "${VERSION}" ]] ; then echo "Destination / clone was set but version was not!"; exit 1;fi -if [[ "${DESTINATION}" != "" && "${CLONE}" == "yes" ]] ; then echo "Destination and clone was set. Pick one!"; exit 1;fi -} - -# Prints the usage -function print_usage() { -cat </` -- if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will - switch to gh-pages of that repo and copy the generated docs to `docs//` - -USAGE: - -You can use the following options: - --v|--version - the script will apply the whole procedure for a particular library version --d|--destination - the root of destination folder where the docs should be copied. You have to use the full path. - E.g. point to spring-cloud-static folder. Can't be used with (-c) --b|--build - will run the standard build process after checking out the branch --c|--clone - will automatically clone the spring-cloud-static repo instead of providing the destination. - Obviously can't be used with (-d) - -EOF -} - - -# ========================================== -# ____ ____ _____ _____ _____ _______ -# / ____|/ ____| __ \|_ _| __ \__ __| -# | (___ | | | |__) | | | | |__) | | | -# \___ \| | | _ / | | | ___/ | | -# ____) | |____| | \ \ _| |_| | | | -# |_____/ \_____|_| \_\_____|_| |_| -# -# ========================================== - -while [[ $# > 0 ]] -do -key="$1" -case ${key} in - -v|--version) - VERSION="$2" - shift # past argument - ;; - -d|--destination) - DESTINATION="$2" - shift # past argument - ;; - -b|--build) - BUILD="yes" - ;; - -c|--clone) - CLONE="yes" - ;; - -h|--help) - print_usage - exit 0 - ;; - *) - echo "Invalid option: [$1]" - print_usage - exit 1 - ;; -esac -shift # past argument or value -done - -assert_properties -set_default_props -check_if_anything_to_sync -if [[ -z "${VERSION}" ]] ; then - retrieve_current_branch -else - switch_to_tag -fi -build_docs_if_applicable -retrieve_doc_properties -stash_changes -add_docs_from_target -checkout_previous_branch \ No newline at end of file diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc deleted file mode 100644 index 77295c64..00000000 --- a/docs/src/main/asciidoc/intro.adoc +++ /dev/null @@ -1,23 +0,0 @@ -Spring Cloud Release Train is a curated set of dependencies across a -range of Spring Cloud projects. You consume it by using the -spring-cloud-dependencies POM to manage dependencies in Maven or -Gradle. The release trains have names, not versions, to avoid -confusion with the sub-projects. The names are an alphabetic sequence -(so you can sort them chronologically) with names of London Tube -stations ("Angel" is the first release, "Brixton" is the second). - -== Generating release train documentation - -In order to generate the release train documentation, please update the project with versions for a given release train and then execute the following command: - -```bash -$ ./mvnw clean install -Pdocs,train-docs -pl train-docs -``` - -In order to upload the documentation to the documentation server just execute the following command: - -```bash -$ ./mvnw clean deploy -Pdocs,train-docs -pl train-docs -``` - -IMPORTANT: If you're releasing milestones don't forget to add `-Pmilestone` and if GA `-Pcentral`. \ No newline at end of file diff --git a/docs/src/main/asciidoc/spring-cloud-starters.adoc b/docs/src/main/asciidoc/spring-cloud-starters.adoc deleted file mode 100644 index c9f670bc..00000000 --- a/docs/src/main/asciidoc/spring-cloud-starters.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Spring Cloud Release Train - -include::intro.adoc[] - -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing-docs.adoc[] diff --git a/package.json b/package.json new file mode 100644 index 00000000..8434c31b --- /dev/null +++ b/package.json @@ -0,0 +1,10 @@ +{ + "dependencies": { + "antora": "3.2.0-alpha.12", + "@antora/atlas-extension": "1.0.0-alpha.5", + "@antora/collector-extension": "1.0.3", + "@asciidoctor/tabs": "1.0.0-beta.6", + "@springio/antora-extensions": "1.14.12", + "@springio/asciidoctor-extensions": "1.0.0-alpha.18" + } +} diff --git a/pom.xml b/pom.xml index 1f25f7c3..0ad01c14 100644 --- a/pom.xml +++ b/pom.xml @@ -1,183 +1,63 @@ - - - 4.0.0 - spring-cloud-starter-build - pom - Spring Cloud Starter Build - Spring Cloud Starter Build - 2023.0.0-SNAPSHOT - - org.springframework.cloud - spring-cloud-build - 4.1.0-SNAPSHOT - - - - - https://github.com/spring-cloud/spring-cloud-release - scm:git:git://github.com/spring-cloud/spring-cloud-release.git - scm:git:ssh://git@github.com/spring-cloud/spring-cloud-release.git - HEAD - - - - starters - - - - spring-cloud-dependencies - spring-cloud-starter-parent - docs - - - - - - org.apache.maven.plugins - maven-enforcer-plugin - - - enforce-rules - - enforce - - - - - - commons-logging:*:* - - true - - - - true - - - - - - io.spring.javaformat - spring-javaformat-maven-plugin - - - org.apache.maven.plugins - maven-checkstyle-plugin - - - org.codehaus.mojo - flatten-maven-plugin - true - - - - flatten - process-resources - - flatten - - - true - oss - - expand - remove - remove - - - - - - - - - - - - org.apache.maven.plugins - maven-checkstyle-plugin - - - - - - - all - - spring-cloud-dependencies - spring-cloud-starter-parent - docs - train-docs - - - - train-docs - - train-docs - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - false - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - false - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/libs-release-local - - false - - - - - - + + + 4.0.0 + spring-cloud-release-docs-build + 0.0.1-SNAPSHOT + + org.springframework.cloud + spring-cloud-starter-build + 2025.1.2-SNAPSHOT + + Spring Cloud Release Docs Build + Builds Spring Cloud Release Docs. + https://spring.io/projects/spring-cloud-release + + scm:git:https://github.com/spring-cloud/spring-cloud-release.git + + + scm:git:git@github.com:spring-cloud/spring-cloud-release.git + + https://github.com/spring-cloud/spring-cloud-release + + + https://github.com/spring-cloud/spring-cloud-release/issues + + + + + org.antora + antora-maven-plugin + + + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + true + false + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + false + + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + true + false + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + false + + diff --git a/spring-cloud-dependencies/pom.xml b/spring-cloud-dependencies/pom.xml deleted file mode 100644 index aee40472..00000000 --- a/spring-cloud-dependencies/pom.xml +++ /dev/null @@ -1,243 +0,0 @@ - - - 4.0.0 - - org.springframework.cloud - spring-cloud-dependencies-parent - 4.1.0-SNAPSHOT - - - spring-cloud-dependencies - 2023.0.0-SNAPSHOT - spring-cloud-dependencies - Spring Cloud Dependencies - https://spring.io/projects/spring-cloud - pom - - ${basedir}/../.. - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 3.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 3.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 3.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - 4.1.0-SNAPSHOT - - - scm:git:git://github.com/spring-cloud/spring-cloud-release.git/spring-cloud-dependencies - scm:git:ssh://git@github.com/spring-cloud/spring-cloud-release.git/spring-cloud-dependencies - https://github.com/spring-cloud/spring-cloud-release/spring-cloud-dependencies - - - - spring-docs - https://docs.spring.io/spring-cloud/docs/${pom.version}/reference/html/ - - https://github.com/spring-cloud/spring-cloud-release - - - - - - org.springframework.cloud - spring-cloud-commons-dependencies - ${spring-cloud-commons.version} - pom - import - - - org.springframework.cloud - spring-cloud-netflix-dependencies - ${spring-cloud-netflix.version} - pom - import - - - org.springframework.cloud - spring-cloud-stream-dependencies - ${spring-cloud-stream.version} - pom - import - - - org.springframework.cloud - spring-cloud-task-dependencies - ${spring-cloud-task.version} - pom - import - - - org.springframework.cloud - spring-cloud-circuitbreaker-dependencies - ${spring-cloud-circuitbreaker.version} - pom - import - - - org.springframework.cloud - spring-cloud-config-dependencies - ${spring-cloud-config.version} - pom - import - - - org.springframework.cloud - spring-cloud-function-dependencies - ${spring-cloud-function.version} - pom - import - - - org.springframework.cloud - spring-cloud-gateway-dependencies - ${spring-cloud-gateway.version} - pom - import - - - org.springframework.cloud - spring-cloud-consul-dependencies - ${spring-cloud-consul.version} - pom - import - - - org.springframework.cloud - spring-cloud-vault-dependencies - ${spring-cloud-vault.version} - pom - import - - - org.springframework.cloud - spring-cloud-zookeeper-dependencies - ${spring-cloud-zookeeper.version} - pom - import - - - org.springframework.cloud - spring-cloud-bus-dependencies - ${spring-cloud-bus.version} - pom - import - - - org.springframework.cloud - spring-cloud-contract-dependencies - ${spring-cloud-contract.version} - pom - import - - - org.springframework.cloud - spring-cloud-openfeign-dependencies - ${spring-cloud-openfeign.version} - pom - import - - - org.springframework.cloud - spring-cloud-kubernetes-dependencies - ${spring-cloud-kubernetes.version} - pom - import - - - - - - - org.codehaus.mojo - flatten-maven-plugin - false - - - - flatten - process-resources - - flatten - - - true - bom - - expand - keep - keep - remove - - - - - flatten-clean - clean - - clean - - - - - - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - diff --git a/spring-cloud-dependencies/src/main/resources/META-INF/spring.provides b/spring-cloud-dependencies/src/main/resources/META-INF/spring.provides deleted file mode 100644 index 3628be6e..00000000 --- a/spring-cloud-dependencies/src/main/resources/META-INF/spring.provides +++ /dev/null @@ -1 +0,0 @@ -provides: spring-cloud-config-client \ No newline at end of file diff --git a/spring-cloud-starter-parent/pom.xml b/spring-cloud-starter-parent/pom.xml deleted file mode 100644 index d538e5b6..00000000 --- a/spring-cloud-starter-parent/pom.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - 4.0.0 - - org.springframework.boot - spring-boot-starter-parent - 3.2.0-SNAPSHOT - - - org.springframework.cloud - spring-cloud-starter-parent - 2023.0.0-SNAPSHOT - spring-cloud-starter-parent - Spring Cloud Starter Parent - pom - https://projects.spring.io/spring-cloud - - Pivotal Software, Inc. - https://www.spring.io - - - ${basedir}/../.. - 2023.0.0-SNAPSHOT - - - - - org.springframework.cloud - spring-cloud-dependencies - ${spring-cloud.version} - pom - import - - - - - https://github.com/spring-cloud - - spring-docs - - scp://static.springframework.org/var/www/domains/springframework.org/static/htdocs/spring-cloud/docs/${project.artifactId}/${project.version} - - - - repo.spring.io - Spring Release Repository - https://repo.spring.io/libs-release-local - - - repo.spring.io - Spring Snapshot Repository - https://repo.spring.io/libs-snapshot-local - - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - milestone - - - repo.spring.io - Spring Milestone Repository - https://repo.spring.io/libs-milestone-local - - - - - bintray - - - bintray - Jcenter Repository - https://api.bintray.com/maven/spring/jars/org.springframework.cloud:${bintray.package} - - - - - central - - - - org.apache.maven.plugins - maven-gpg-plugin - - - sign-artifacts - verify - - sign - - - - - - - - - sonatype-nexus-snapshots - Sonatype Nexus Snapshots - https://s01.oss.sonatype.org/content/repositories/snapshots/ - - - sonatype-nexus-staging - Nexus Release Repository - https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ - - - - - diff --git a/spring-cloud-starter-parent/src/main/resources/META-INF/spring.provides b/spring-cloud-starter-parent/src/main/resources/META-INF/spring.provides deleted file mode 100644 index 3628be6e..00000000 --- a/spring-cloud-starter-parent/src/main/resources/META-INF/spring.provides +++ /dev/null @@ -1 +0,0 @@ -provides: spring-cloud-config-client \ No newline at end of file diff --git a/train-docs/pom.xml b/train-docs/pom.xml deleted file mode 100644 index 23a6aa26..00000000 --- a/train-docs/pom.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - 4.0.0 - spring-cloud-docs - - org.springframework.cloud - spring-cloud-starter-build - 2023.0.0-SNAPSHOT - - jar - Spring Cloud Release Train Docs - Spring Cloud Release Train Docs - - spring-cloud - ${basedir}/.. - deploy - - 3.8.5 - 4.3.0 - 2.5.3 - 2.11.0 - - none - none - - - - org.springframework - spring-core - - - org.apache.maven - maven-model - ${maven.version} - - - com.github.jknack - handlebars - ${handlebars.version} - - - commons-io - commons-io - ${commons-io.version} - - - - org.springframework.boot - spring-boot-starter-test - test - - - - - docs - - - - org.apache.maven.plugins - maven-surefire-plugin - - - ${maven.multiModuleProjectDirectory}/spring-cloud-dependencies/pom.xml - ${maven.multiModuleProjectDirectory}/spring-cloud-starter-parent/pom.xml - ${maven-deploy-plugin.deployZipUrl} - ${project.build.directory}/unpacked-docs/ - ${project.build.directory}/train-docs/ - - - - - pl.project13.maven - git-commit-id-plugin - - - maven-dependency-plugin - - - maven-resources-plugin - - - org.codehaus.mojo - exec-maven-plugin - - - run-template-generation - prepare-package - - java - - - true - org.springframework.cloud.internal.GenerateReleaseTrainDocs - - ${maven.multiModuleProjectDirectory}/spring-cloud-dependencies/pom.xml - ${maven.multiModuleProjectDirectory}/spring-cloud-starter-parent/pom.xml - https://github.com/spring-cloud/ - ${project.build.directory}/unpacked-docs/ - ${project.build.directory}/train-docs/ - - - - - - - org.asciidoctor - asciidoctor-maven-plugin - - ${project.build.directory}/train-docs/ - - ${project.build.directory}/unpacked-docs - true - - - - - maven-antrun-plugin - - - maven-deploy-plugin - - deploy-file - - - - - - - diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/ArtifactFetcher.java b/train-docs/src/main/java/org/springframework/cloud/internal/ArtifactFetcher.java deleted file mode 100644 index 1b3a6e4c..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/ArtifactFetcher.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.IOException; -import java.net.URL; -import java.util.LinkedList; -import java.util.List; - -import org.apache.commons.io.FileUtils; - -import org.springframework.util.FileSystemUtils; - -import static org.springframework.cloud.internal.Logger.error; -import static org.springframework.cloud.internal.Logger.info; - -class ArtifactFetcher { - - private static final int CONNECT_TIMEOUT = 5000; - - private static final int READ_TIMEOUT = 5000; - - private final File outputFolder; - - private final String repoUrl; - - ArtifactFetcher(File outputFolder, String repoUrl) { - this.outputFolder = outputFolder; - this.repoUrl = repoUrl; - } - - File unpackedDocs(Project project) { - String projectName = project.name; - String version = project.version; - List urls = urls(projectName, version); - final File downloadedZipsFolder = new File(outputFolder, "downloaded-zips"); - downloadedZipsFolder.mkdirs(); - File outputZip = new File(downloadedZipsFolder, projectName + ".zip"); - for (String url : urls) { - try { - info(projectName + ": Fetching sources from [" + url + "]. Please wait..."); - FileUtils.copyURLToFile(new URL(url), outputZip, CONNECT_TIMEOUT, READ_TIMEOUT); - info(projectName + ": Successfully fetched a zip from [" + url + "] to [" + outputZip + "]"); - break; - } - catch (IOException ex) { - error(projectName + ": Failed to fetch a zip from [" + url + "]"); - } - } - if (!outputZip.exists()) { - error(projectName + ": Exception occurred while trying to download an artifact with name [" + projectName - + "] and version [" + version + "]"); - return null; - } - return unpackDocs(projectName, outputZip); - } - - private File unpackDocs(String projectName, File outputZip) { - File unpackedDoc = unpackDoc(projectName, outputZip); - info(projectName + ": Unpacked file to [" + unpackedDoc.getAbsolutePath() + "]"); - if (unpackedDoc.isDirectory()) { - String[] subfolders = unpackedDoc.list(); - if (subfolders == null || subfolders.length != 1) { - return unpackedDoc; - } - moveOneFolderUp(unpackedDoc, subfolders[0]); - } - return unpackedDoc; - } - - private void moveOneFolderUp(File unpackedDoc, String subfolder) { - File onlySubfolder = new File(unpackedDoc, subfolder); - try { - FileSystemUtils.copyRecursively(onlySubfolder, unpackedDoc); - } - catch (IOException e) { - throw new IllegalStateException(e); - } - FileSystemUtils.deleteRecursively(onlySubfolder); - } - - private List urls(String projectName, String version) { - ReleaseType releaseType = ReleaseType.fromVersion(version); - String sourcesUrl = this.repoUrl + projectName + "/archive/"; - List sourcesUrls = new LinkedList<>(); - if (releaseType == ReleaseType.SNAPSHOT) { - // 2.0.0-SNAPSHOT or 2.0.0-BUILD-SNAPSHOT -> 2.0.x - String[] splitVersion = version.split("\\."); - sourcesUrls.add(sourcesUrl + splitVersion[0] + "." + splitVersion[1] + ".x.zip"); - // fallback - sourcesUrls.add(sourcesUrl + "main.zip"); - sourcesUrls.add(sourcesUrl + "master.zip"); - } - else { - sourcesUrls.add(sourcesUrl + "v" + version + ".zip"); - sourcesUrls.add(sourcesUrl + version + ".zip"); - } - return sourcesUrls; - } - - private File unpackDoc(String artifactName, File zip) { - File unzippedDocs = new File(outputFolder, artifactName); - unzippedDocs.mkdirs(); - info(artifactName + ": Unpacking from [" + zip + "]"); - ZipCategory.unzipTo(zip, unzippedDocs); - return unzippedDocs; - } - -} - -enum ReleaseType { - - SNAPSHOT, NON_SNAPSHOT; - - static ReleaseType fromVersion(String version) { - if (isSnapshot(version)) { - return ReleaseType.SNAPSHOT; - } - return ReleaseType.NON_SNAPSHOT; - } - - private static boolean isSnapshot(String version) { - return version.contains("SNAPSHOT"); - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationPropertiesAggregator.java b/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationPropertiesAggregator.java deleted file mode 100644 index 8a2ff145..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationPropertiesAggregator.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.Arrays; -import java.util.Comparator; -import java.util.List; -import java.util.stream.Collectors; - -import org.springframework.util.StringUtils; - -class ConfigurationPropertiesAggregator { - - private static final List wordsToIgnore = Arrays.asList("|===", "|Name | Default | Description"); - - List mergedConfigurationProperties(Path unpackedDocs) { - try { - return Files.walk(unpackedDocs).filter(path -> path.endsWith("_configprops.adoc")).flatMap(path -> { - try { - return Files.readAllLines(path).stream() - .filter(s -> !StringUtils.isEmpty(s) && !wordsToIgnore.contains(s)).map(s -> { - // |foo|bar|baz -> foo|bar|baz -> split -> - // foo,bar,baz - String[] strings = s.substring(1).split("\\|"); - if (strings.length == 3) { - return new ConfigurationProperty(strings[0].trim(), - strings[1].trim().replace("`", ""), strings[2].trim()); - } - else if (strings.length == 2) { - return new ConfigurationProperty(strings[0].trim(), - strings[1].trim().replace("`", ""), ""); - } - return new ConfigurationProperty(strings[0].trim(), "", ""); - }); - } - catch (IOException e) { - throw new IllegalStateException(e); - } - }).sorted(Comparator.comparing(o -> o.name)).collect(Collectors.toList()); - } - catch (IOException e) { - throw new IllegalStateException(e); - } - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationProperty.java b/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationProperty.java deleted file mode 100644 index 14934f1e..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/ConfigurationProperty.java +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.util.Objects; - -class ConfigurationProperty { - - final String name; - - final String defaultValue; - - final String description; - - ConfigurationProperty(String name, String defaultValue, String description) { - this.name = name; - this.defaultValue = defaultValue; - this.description = description; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ConfigurationProperty that = (ConfigurationProperty) o; - return Objects.equals(name, that.name) && Objects.equals(description, that.description) - && Objects.equals(defaultValue, that.defaultValue); - } - - @Override - public int hashCode() { - return Objects.hash(name, description, defaultValue); - } - - public String getName() { - return name; - } - - public String getDescription() { - return description; - } - - public String getDefaultValue() { - return defaultValue; - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/GenerateReleaseTrainDocs.java b/train-docs/src/main/java/org/springframework/cloud/internal/GenerateReleaseTrainDocs.java deleted file mode 100644 index cf8642ad..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/GenerateReleaseTrainDocs.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.util.Comparator; -import java.util.LinkedList; -import java.util.List; -import java.util.Objects; -import java.util.Properties; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.stream.Collectors; - -import org.apache.maven.model.Model; - -import static org.springframework.cloud.internal.Logger.info; - -public class GenerateReleaseTrainDocs { - - final ExecutorService service; - - public static void main(String... args) { - File bomPath = new File(args[0]); - File starterParentPath = new File(args[1]); - String repoUrl = args[2]; - File unzippedDocs = new File(args[3]); - File generatedTrainDocs = new File(args[4]); - new GenerateReleaseTrainDocs().generate(bomPath, starterParentPath, repoUrl, unzippedDocs, generatedTrainDocs); - } - - GenerateReleaseTrainDocs() { - this.service = Executors.newFixedThreadPool(4); - } - - void generate(File bomPath, File starterParentPath, String repoUrl, File unzippedDocs, File generatedTrainDocs) { - List projects = mavenPropertiesToDocsProjects(bomPath); - info("Found the following projects [" + projects + "]"); - List outputFolders = downloadSources(unzippedDocs, projects, repoUrl); - projects.add(springBootVersion(starterParentPath)); - projects.sort(Comparator.comparing(o -> o.name)); - List configurationProperties = mergeConfigurationProperties(unzippedDocs); - File file = renderAsciidocTemplates(generatedTrainDocs, projects, configurationProperties); - info("Rendered docs templates to [" + file + "]"); - new ResourcesCopier().copy(outputFolders, file); - } - - List mavenPropertiesToDocsProjects(File file) { - Model model = PomReader.readPom(file); - Properties properties = model.getProperties(); - return properties.entrySet().stream().filter(e -> e.getKey().toString().endsWith(".version")) - .map(e -> new Project(e.getKey().toString().replace(".version", ""), e.getValue().toString())) - .collect(Collectors.toCollection(LinkedList::new)); - } - - Project springBootVersion(File file) { - Model model = PomReader.readPom(file); - return new Project("spring-boot", model.getParent().getVersion()); - } - - List downloadSources(File outputFolder, List projects, String repoUrl) { - ArtifactFetcher fetcher = new ArtifactFetcher(outputFolder, repoUrl); - try { - List> futures = new LinkedList<>(); - for (Project project : projects) { - futures.add(service.submit(() -> fetcher.unpackedDocs(project))); - } - List files = futures.stream().map(future -> { - try { - return future.get(5, TimeUnit.MINUTES); - } - catch (Exception e) { - throw new IllegalStateException(e); - } - }).filter(Objects::nonNull).collect(Collectors.toList()); - info("Unpacked docs modules to the following directories [" + files + "]"); - return files; - } - finally { - service.shutdown(); - } - } - - List mergeConfigurationProperties(File outputFolderWithDocs) { - ConfigurationPropertiesAggregator aggregator = new ConfigurationPropertiesAggregator(); - return aggregator.mergedConfigurationProperties(outputFolderWithDocs.toPath()); - } - - File renderAsciidocTemplates(File generatedTrainDocs, List projects, - List configurationProperties) { - TemplateGenerator templateGenerator = new TemplateGenerator(generatedTrainDocs); - return templateGenerator.generate(projects, configurationProperties); - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/HandlebarsHelper.java b/train-docs/src/main/java/org/springframework/cloud/internal/HandlebarsHelper.java deleted file mode 100644 index 093c88a8..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/HandlebarsHelper.java +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.IOException; - -import com.github.jknack.handlebars.Handlebars; -import com.github.jknack.handlebars.Template; -import com.github.jknack.handlebars.helper.StringHelpers; -import com.github.jknack.handlebars.io.ClassPathTemplateLoader; - -/** - * @author Marcin Grzejszczak - */ -final class HandlebarsHelper { - - private HandlebarsHelper() { - throw new IllegalStateException("Can't instantiate a utility class"); - } - - public static Template template(String templateName) { - try { - Handlebars handlebars = new Handlebars(new ClassPathTemplateLoader("/templates/spring-cloud/")); - handlebars.registerHelper("replace", StringHelpers.replace); - handlebars.registerHelper("capitalizeFirst", StringHelpers.capitalizeFirst); - return handlebars.compile(templateName); - } - catch (IOException e) { - throw new IllegalStateException(e); - } - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/Logger.java b/train-docs/src/main/java/org/springframework/cloud/internal/Logger.java deleted file mode 100644 index 41cde9be..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/Logger.java +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -final class Logger { - - private Logger() { - - } - - static void info(String text) { - System.out.println(text); - } - - static void error(String text) { - System.err.println(text); - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/PomReader.java b/train-docs/src/main/java/org/springframework/cloud/internal/PomReader.java deleted file mode 100644 index 57eb4492..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/PomReader.java +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.FileReader; -import java.io.IOException; -import java.io.Reader; -import java.nio.file.Files; - -import org.apache.maven.model.Model; -import org.apache.maven.model.io.xpp3.MavenXpp3Reader; -import org.codehaus.plexus.util.xml.pull.XmlPullParserException; - -/** - * Class that reads poms as {@link Model}. - * - * @author Marcin Grzejszczak - */ -final class PomReader { - - private PomReader() { - throw new IllegalStateException("Shouldn't instantiate a utility class"); - } - - /** - * Returns a parsed POM. - * @param pom location to the pom - * @return parsed model - */ - public static Model readPom(File pom) { - if (!pom.exists()) { - throw new IllegalStateException("File [" + pom.getAbsolutePath() + "] not found"); - } - String fileText = ""; - try (Reader reader = new FileReader(pom)) { - if (pom.isFile()) { - fileText = new String(Files.readAllBytes(pom.toPath())); - } - MavenXpp3Reader xpp3Reader = new MavenXpp3Reader(); - return xpp3Reader.read(reader); - } - catch (XmlPullParserException | IOException e) { - if (pom.isFile() && fileText.length() == 0) { - throw new IllegalStateException("File [" + pom.getAbsolutePath() + "] is empty", e); - } - throw new IllegalStateException("Failed to read file: " + pom.getAbsolutePath(), e); - } - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/Project.java b/train-docs/src/main/java/org/springframework/cloud/internal/Project.java deleted file mode 100644 index d6c01cb3..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/Project.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.util.Objects; - -class Project { - - final String name; - - final String version; - - Project(String name, String version) { - this.name = name; - this.version = version; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Project project = (Project) o; - return Objects.equals(name, project.name) && Objects.equals(version, project.version); - } - - @Override - public int hashCode() { - return Objects.hash(name, version); - } - - public String getName() { - return name; - } - - public String getVersion() { - return version; - } - - @Override - public String toString() { - return "Project{" + "name='" + this.name + '\'' + ", version='" + this.version + '\'' + '}'; - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/ResourcesCopier.java b/train-docs/src/main/java/org/springframework/cloud/internal/ResourcesCopier.java deleted file mode 100644 index e45681bb..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/ResourcesCopier.java +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.IOException; -import java.util.List; - -import org.springframework.util.FileSystemUtils; - -final class ResourcesCopier { - - void copy(List baseDirs, File output) { - File images = new File(output, "images"); - baseDirs.forEach(input -> { - try { - File inputImages = new File(input, "images"); - if (!inputImages.exists()) { - return; - } - Logger.info("Will copy [" + inputImages + "] files to [" + images + "]"); - FileSystemUtils.copyRecursively(inputImages, images); - } - catch (IOException e) { - throw new IllegalStateException(e); - } - }); - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/TemplateGenerator.java b/train-docs/src/main/java/org/springframework/cloud/internal/TemplateGenerator.java deleted file mode 100644 index f59f0289..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/TemplateGenerator.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.IOException; -import java.nio.file.Files; -import java.util.HashMap; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.stream.Collectors; - -import com.github.jknack.handlebars.Template; - -import org.springframework.core.io.Resource; -import org.springframework.core.io.support.PathMatchingResourcePatternResolver; - -import static org.springframework.cloud.internal.Logger.info; - -/** - * @author Marcin Grzejszczak - */ -class TemplateGenerator { - - final File outputFolder; - - TemplateGenerator(File outputFolder) { - this.outputFolder = outputFolder; - this.outputFolder.mkdirs(); - } - - File generate(List projects, List configurationProperties) { - PathMatchingResourcePatternResolver resourceLoader = new PathMatchingResourcePatternResolver(); - try { - Resource[] resources = resourceLoader.getResources("templates/spring-cloud/*.hbs"); - List templateProjects = templateProjects(projects); - for (Resource resource : resources) { - File templateFile = resource.getFile(); - File outputFile = new File(outputFolder, renameTemplate(templateFile)); - Template template = template(templateFile.getName().replace(".hbs", "")); - Map map = new HashMap<>(); - map.put("projects", projects); - map.put("springCloudProjects", templateProjects); - map.put("properties", configurationProperties); - String applied = template.apply(map); - Files.write(outputFile.toPath(), applied.getBytes()); - info("Successfully rendered [" + outputFile.getAbsolutePath() + "]"); - } - } - catch (IOException e) { - throw new IllegalStateException(e); - } - return outputFolder; - } - - private List templateProjects(List projects) { - return projects.stream().filter(project -> project.name.startsWith("spring-cloud-")).map(project -> { - return new TemplateProject(project.name, project.version, - "{basedir}/" + project.name + "/docs/src/main/asciidoc/" + project.name + ".adoc[leveloffset=+1]"); - }).collect(Collectors.toCollection(LinkedList::new)); - } - - private String renameTemplate(File templateFile) { - String templateName = templateFile.getName(); - if (templateName.endsWith("-pdf.hbs")) { - return templateName.replace("-pdf.hbs", ".pdfadoc"); - } - else if (templateName.endsWith("-single.hbs")) { - return templateName.replace("-single.hbs", ".htmlsingleadoc"); - } - return templateName.replace(".hbs", ".adoc"); - } - - private Template template(String template) { - return HandlebarsHelper.template(template); - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/TemplateProject.java b/train-docs/src/main/java/org/springframework/cloud/internal/TemplateProject.java deleted file mode 100644 index 26112d5a..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/TemplateProject.java +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.util.Objects; - -class TemplateProject { - - final String name; - - final String version; - - final String include; - - TemplateProject(String name, String version, String include) { - this.name = name; - this.version = version; - this.include = include; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplateProject that = (TemplateProject) o; - return Objects.equals(name, that.name) && Objects.equals(version, that.version) - && Objects.equals(include, that.include); - } - - @Override - public int hashCode() { - return Objects.hash(name, version, include); - } - - public String getName() { - return name; - } - - public String getVersion() { - return version; - } - - public String getInclude() { - return include; - } - -} diff --git a/train-docs/src/main/java/org/springframework/cloud/internal/ZipCategory.java b/train-docs/src/main/java/org/springframework/cloud/internal/ZipCategory.java deleted file mode 100644 index 7d6444e3..00000000 --- a/train-docs/src/main/java/org/springframework/cloud/internal/ZipCategory.java +++ /dev/null @@ -1,107 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.nio.file.Files; -import java.util.ArrayList; -import java.util.Collection; -import java.util.List; -import java.util.zip.ZipEntry; -import java.util.zip.ZipException; -import java.util.zip.ZipInputStream; - -import org.springframework.util.StreamUtils; - -/** - * Based on - * https://github.com/ - * timyates/groovy-common-extensions. - * - * Category for {@link File} that adds a method that allows you to unzip a given file to a - * specified location - * - * @author Marcin Grzejszczak - */ -final class ZipCategory { - - private ZipCategory() { - throw new IllegalStateException("Can't instantiate a utility class"); - } - - /** - * Unzips this file. If the destination directory is not provided, it will - * fall back to this file's parent directory. - * @param self file - * @param destination (optional), the destination directory where this file's content - * will be unzipped to. - * @return a {@link Collection} of unzipped {@link File} objects. - */ - public static Collection unzipTo(File self, File destination) { - checkUnzipDestination(destination); - // if destination directory is not given, we'll fall back to the parent directory - // of 'self' - if (destination == null) { - destination = new File(self.getParent()); - } - List unzippedFiles = new ArrayList<>(); - try (InputStream fileInputStream = Files.newInputStream(self.toPath())) { - try (ZipInputStream zipInput = new ZipInputStream(fileInputStream)) { - for (ZipEntry entry = zipInput.getNextEntry(); entry != null; entry = zipInput.getNextEntry()) { - if (!entry.isDirectory()) { - final File destinationFile = new File(destination, entry.getName()); - /* - * If we see the relative traversal string of ".." we need to make - * sure that the outputdir + name doesn't leave the outputdir. - */ - String zipEntryName = entry.getName(); - if (!destinationFile.toPath().normalize().startsWith(destination.toPath())) { - throw new ZipException("The file " + zipEntryName - + " is trying to leave the target output directory of " + destination); - } - if (destinationFile.getParentFile() != null) { - destinationFile.getParentFile().mkdirs(); - } - try (OutputStream output = Files.newOutputStream(destinationFile.toPath())) { - StreamUtils.copy(zipInput, output); - } - unzippedFiles.add(destinationFile); - } - else { - final File dir = new File(destination, entry.getName()); - dir.mkdirs(); - unzippedFiles.add(dir); - } - } - } - } - catch (IOException e) { - throw new IllegalStateException("Cannot unzip archive", e); - } - return unzippedFiles; - } - - private static void checkUnzipDestination(File file) { - if (file != null && !file.isDirectory()) { - throw new IllegalArgumentException("'destination' has to be a directory."); - } - } - -} diff --git a/train-docs/src/main/resources/templates/spring-cloud/_attributes.hbs b/train-docs/src/main/resources/templates/spring-cloud/_attributes.hbs deleted file mode 100644 index d12fc701..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/_attributes.hbs +++ /dev/null @@ -1,17 +0,0 @@ -:doctype: book -:idprefix: -:idseparator: - -:toc: left -:toclevels: 4 -:tabsize: 4 -:numbered: -:sectanchors: -:sectnums: -:icons: font -:hide-uri-scheme: -:docinfo: shared,private -:train-docs: true - -:project-full-name: Spring Cloud -:project-name: spring-cloud -:spring-cloud-code: https://github.com/{project-name} diff --git a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-attributes.hbs b/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-attributes.hbs deleted file mode 100644 index 787cf159..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-attributes.hbs +++ /dev/null @@ -1,2 +0,0 @@ -{{#each projects}}:{{name}}-version: {{version}} -{{/each}} diff --git a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-links.hbs b/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-links.hbs deleted file mode 100644 index 4be4b68b..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-links.hbs +++ /dev/null @@ -1,2 +0,0 @@ -{{#each springCloudProjects}} https://docs.spring.io/{{name}}/docs/{{version}}/reference/html/[{{name}}] :: {{name}} Reference Documentation, version {{version}} -{{/each}} diff --git a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-versions.hbs b/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-versions.hbs deleted file mode 100644 index 6ae15ac5..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/_spring-cloud-versions.hbs +++ /dev/null @@ -1,2 +0,0 @@ -{{#each projects}} |{{name}}|{{version}} -{{/each}} \ No newline at end of file diff --git a/train-docs/src/main/resources/templates/spring-cloud/configprops.hbs b/train-docs/src/main/resources/templates/spring-cloud/configprops.hbs deleted file mode 100644 index c292132d..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/configprops.hbs +++ /dev/null @@ -1,7 +0,0 @@ -|=== -|Name | Default | Description - -{{#each properties}} |{{name}} | `{{defaultValue}}` | {{description}} -{{/each}} - -|=== \ No newline at end of file diff --git a/train-docs/src/main/resources/templates/spring-cloud/documentation-overview.hbs b/train-docs/src/main/resources/templates/spring-cloud/documentation-overview.hbs deleted file mode 100644 index 73b54333..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/documentation-overview.hbs +++ /dev/null @@ -1,38 +0,0 @@ -[[documentation]] -= Spring Cloud Documentation -include::_attributes.adoc[] - -:docs-url: https://docs.spring.io/spring-cloud/docs/{spring-cloud-version} - -This section provides a brief overview of Spring Cloud reference documentation. It serves -as a map for the rest of the document. - - - -[[documentation-about]] -== About the Documentation - -The {project-full-name} reference guide is available as - -* {docs-url}/reference/html[Multi-page HTML] -* {docs-url}/reference/htmlsingle[Single-page HTML] -* {docs-url}/reference/pdf/{project-name}.pdf[PDF] - -Copies of this document may be made for your own use and for distribution to others, -provided that you do not charge any fee for such copies and further provided that each -copy contains this Copyright Notice, whether distributed in print or electronically. - - - -[[documentation-getting-help]] -== Getting Help -If you have trouble with {project-full-name}, we would like to help. - -* Learn the {project-full-name} basics. If you are -starting out with {project-full-name}, try one of the https://spring.io/guides[guides]. -* Ask a question. We monitor https://stackoverflow.com[stackoverflow.com] for questions -tagged with https://stackoverflow.com/tags/spring-cloud[`spring-cloud`]. -* Chat with us at https://gitter.im/spring-cloud/spring-cloud[{project-full-name} Gitter] - -NOTE: All of {project-full-name} is open source, including the documentation. If you find -problems with the docs or if you want to improve them, please {spring-cloud-code}[get involved]. diff --git a/train-docs/src/main/resources/templates/spring-cloud/index-single.hbs b/train-docs/src/main/resources/templates/spring-cloud/index-single.hbs deleted file mode 100644 index 4057ff57..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/index-single.hbs +++ /dev/null @@ -1 +0,0 @@ -include::spring-cloud.htmlsingleadoc[] diff --git a/train-docs/src/main/resources/templates/spring-cloud/index.hbs b/train-docs/src/main/resources/templates/spring-cloud/index.hbs deleted file mode 100644 index f642e5a7..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/index.hbs +++ /dev/null @@ -1 +0,0 @@ -include::spring-cloud.adoc[] diff --git a/train-docs/src/main/resources/templates/spring-cloud/legal.hbs b/train-docs/src/main/resources/templates/spring-cloud/legal.hbs deleted file mode 100644 index 048c5ada..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/legal.hbs +++ /dev/null @@ -1,11 +0,0 @@ -[legal] -= Legal - -{spring-cloud-version} - -Copyright © 2012-2020 - -Copies of this document may be made for your own use and for distribution to -others, provided that you do not charge any fee for such copies and further -provided that each copy contains this Copyright Notice, whether distributed in -print or electronically. \ No newline at end of file diff --git a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-pdf.hbs b/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-pdf.hbs deleted file mode 100644 index 18449358..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-pdf.hbs +++ /dev/null @@ -1,57 +0,0 @@ -= Spring Cloud - -include::_attributes.adoc[] -include::_spring-cloud-attributes.adoc[] - -:basedir: {project-root} -:project-full-name: Spring Cloud -:project-name: spring-cloud - -Spring Cloud provides tools for developers to quickly build some of -the common patterns in distributed systems (e.g. configuration -management, service discovery, circuit breakers, intelligent routing, -micro-proxy, control bus). Coordination of -distributed systems leads to boiler plate patterns, and using Spring -Cloud developers can quickly stand up services and applications that -implement those patterns. They will work well in any distributed -environment, including the developer's own laptop, bare metal data -centres, and managed platforms such as Cloud Foundry. - -Release Train Version: *{spring-cloud-version}* - -Supported Boot Version: *{spring-boot-version}* - -== Features - -Spring Cloud focuses on providing good out of box experience for typical use cases -and extensibility mechanism to cover others. - -* Distributed/versioned configuration -* Service registration and discovery -* Routing -* Service-to-service calls -* Load balancing -* Circuit Breakers -* Distributed messaging - -[[cloud-documentation-versions]] -== Release Train Versions - -.Release Train Project Versions -|=== -|Project Name| Project Version - -include::_spring-cloud-versions.adoc[] -|=== - -{{=<% %>=}} -<%#each springCloudProjects%> -:project-root: {basedir}/<%name%> -:project-version: {<%name%>-version} -include::<%include%> -<%/each%> -<%={{ }}=%> - -= Appendix: Compendium of Configuration Properties - -include::configprops.adoc[leveloffset=+1] diff --git a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-single.hbs b/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-single.hbs deleted file mode 100644 index 18449358..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud-single.hbs +++ /dev/null @@ -1,57 +0,0 @@ -= Spring Cloud - -include::_attributes.adoc[] -include::_spring-cloud-attributes.adoc[] - -:basedir: {project-root} -:project-full-name: Spring Cloud -:project-name: spring-cloud - -Spring Cloud provides tools for developers to quickly build some of -the common patterns in distributed systems (e.g. configuration -management, service discovery, circuit breakers, intelligent routing, -micro-proxy, control bus). Coordination of -distributed systems leads to boiler plate patterns, and using Spring -Cloud developers can quickly stand up services and applications that -implement those patterns. They will work well in any distributed -environment, including the developer's own laptop, bare metal data -centres, and managed platforms such as Cloud Foundry. - -Release Train Version: *{spring-cloud-version}* - -Supported Boot Version: *{spring-boot-version}* - -== Features - -Spring Cloud focuses on providing good out of box experience for typical use cases -and extensibility mechanism to cover others. - -* Distributed/versioned configuration -* Service registration and discovery -* Routing -* Service-to-service calls -* Load balancing -* Circuit Breakers -* Distributed messaging - -[[cloud-documentation-versions]] -== Release Train Versions - -.Release Train Project Versions -|=== -|Project Name| Project Version - -include::_spring-cloud-versions.adoc[] -|=== - -{{=<% %>=}} -<%#each springCloudProjects%> -:project-root: {basedir}/<%name%> -:project-version: {<%name%>-version} -include::<%include%> -<%/each%> -<%={{ }}=%> - -= Appendix: Compendium of Configuration Properties - -include::configprops.adoc[leveloffset=+1] diff --git a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud.hbs b/train-docs/src/main/resources/templates/spring-cloud/spring-cloud.hbs deleted file mode 100644 index 531a3ed4..00000000 --- a/train-docs/src/main/resources/templates/spring-cloud/spring-cloud.hbs +++ /dev/null @@ -1,44 +0,0 @@ -= Spring Cloud - -include::_attributes.adoc[] -include::_spring-cloud-attributes.adoc[] - -:basedir: {project-root} - -Spring Cloud provides tools for developers to quickly build some of -the common patterns in distributed systems (e.g. configuration -management, service discovery, circuit breakers, intelligent routing, -micro-proxy, control bus). Coordination of -distributed systems leads to boiler plate patterns, and using Spring -Cloud developers can quickly stand up services and applications that -implement those patterns. They will work well in any distributed -environment, including the developer's own laptop, bare metal data -centres, and managed platforms such as Cloud Foundry. - -Release Train Version: *{spring-cloud-version}* - -Supported Boot Version: *{spring-boot-version}* - -== Features - -Spring Cloud focuses on providing good out of box experience for typical use cases -and extensibility mechanism to cover others. - -* Distributed/versioned configuration -* Service registration and discovery -* Routing -* Service-to-service calls -* Load balancing -* Circuit Breakers -* Distributed messaging - -The reference documentation consists of the following sections: - -[horizontal] -<> :: Legal information. -<> :: About the Documentation, Getting Help, First Steps, and more. -include::_spring-cloud-links.adoc[] - -= Appendix: Compendium of Configuration Properties - -link:configprops.html[Spring Cloud configuration properties] diff --git a/train-docs/src/test/java/org/springframework/cloud/internal/GenerateReleaseTrainDocsTests.java b/train-docs/src/test/java/org/springframework/cloud/internal/GenerateReleaseTrainDocsTests.java deleted file mode 100644 index 82bce012..00000000 --- a/train-docs/src/test/java/org/springframework/cloud/internal/GenerateReleaseTrainDocsTests.java +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.io.IOException; -import java.net.URISyntaxException; -import java.nio.file.Files; -import java.util.Arrays; -import java.util.List; - -import org.assertj.core.api.BDDAssertions; -import org.junit.jupiter.api.Test; - -import org.springframework.util.FileSystemUtils; - -public class GenerateReleaseTrainDocsTests { - - @Test - void should_return_a_list_of_docs_modules_to_download() throws URISyntaxException { - File testPom = new File(GenerateReleaseTrainDocsTests.class.getResource("/test/pom.xml").toURI()); - - List projects = new GenerateReleaseTrainDocs().mavenPropertiesToDocsProjects(testPom); - - BDDAssertions.then(projects).extracting("name").containsOnly("spring-cloud-foo-bus", "spring-cloud-foo-build", - "spring-cloud-foo-commons", "spring-cloud-foo-circuitbreaker", "spring-cloud-foo-config", - "spring-cloud-foo-consul", "spring-cloud-foo-contract", "spring-cloud-foo-function", - "spring-cloud-foo-gateway", "spring-cloud-foo-kubernetes", "spring-cloud-foo-netflix", - "spring-cloud-foo-openfeign", "spring-cloud-foo-task", "spring-cloud-foo-vault", - "spring-cloud-foo-zookeeper"); - BDDAssertions.then(projects).contains(new Project("spring-cloud-foo-bus", "2.2.3.RELEASE")); - } - - @Test - void should_unpack_starters_docs() throws URISyntaxException { - File testPom = new File(GenerateReleaseTrainDocsTests.class.getResource("/test/commons-only.xml").toURI()); - File unzippedDocs = new File("target/test-unpacked-docs/"); - List projects = new GenerateReleaseTrainDocs().mavenPropertiesToDocsProjects(testPom); - - new GenerateReleaseTrainDocs().downloadSources(unzippedDocs, projects, "https://github.com/spring-cloud/"); - - BDDAssertions.then(unzippedDocs).isNotEmptyDirectory(); - } - - @Test - void should_generate_adocs_from_templates() { - File file = new File("target/test-train-docs"); - FileSystemUtils.deleteRecursively(file); - List projects = Arrays.asList(new Project("spring-cloud-foo-foo", "1.0.0"), - new Project("spring-cloud-foo-bar", "2.0.0"), new Project("spring-boot", "3.0.0"), - new Project("spring-cloud", "4.0.0")); - List configurationProperties = Arrays.asList( - new ConfigurationProperty("first", "firstDefault", "firstDescription"), - new ConfigurationProperty("second", "secondDefault", "secondDescription")); - - File outputFolder = new TemplateGenerator(file).generate(projects, configurationProperties); - - BDDAssertions.then(outputFolder).isNotEmptyDirectory(); - } - - @Test - void should_generate_adocs_from_spring_cloud_commons_docs() throws URISyntaxException, IOException { - File generatedAdocs = new File("target/test-train-commons-docs"); - FileSystemUtils.deleteRecursively(generatedAdocs); - File testPom = new File(GenerateReleaseTrainDocsTests.class.getResource("/test/commons-only.xml").toURI()); - File starterPom = new File(GenerateReleaseTrainDocsTests.class.getResource("/test/starter-pom.xml").toURI()); - File unzippedDocs = new File("target/test-unpacked-commons-docs/"); - - GenerateReleaseTrainDocs.main(testPom.getAbsolutePath(), starterPom.getAbsolutePath(), - "https://github.com/spring-cloud/", unzippedDocs.getAbsolutePath(), generatedAdocs.getAbsolutePath()); - - BDDAssertions.then(generatedAdocs).isNotEmptyDirectory(); - BDDAssertions.then(configProps(generatedAdocs)).contains( - "|spring.cloud.compatibility-verifier.enabled | `false` | Enables creation of Spring Cloud compatibility verification."); - } - - private String configProps(File file) throws IOException { - return new String(Files.readAllBytes(new File(file, "configprops.adoc").toPath())); - } - -} diff --git a/train-docs/src/test/java/org/springframework/cloud/internal/TestThatGeneratesTheFinalReleaseTrainDocumentationTests.java b/train-docs/src/test/java/org/springframework/cloud/internal/TestThatGeneratesTheFinalReleaseTrainDocumentationTests.java deleted file mode 100644 index 5e1c4e77..00000000 --- a/train-docs/src/test/java/org/springframework/cloud/internal/TestThatGeneratesTheFinalReleaseTrainDocumentationTests.java +++ /dev/null @@ -1,51 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; - -import org.assertj.core.api.BDDAssertions; -import org.junit.jupiter.api.Assumptions; -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.Test; - -import org.springframework.util.StringUtils; - -public class TestThatGeneratesTheFinalReleaseTrainDocumentationTests { - - /** - * FOR SOME REASON I CAN'T RUN MAIN CLASS FROM MAVEN AS A WORKAOUND WE WILL RUN THIS - * TEST TO GENERATE THE DOCS - */ - @Test - @Disabled - void should_generate_adocs_with_values_from_system_property() { - // System property needs to be passed - Assumptions.assumeTrue(StringUtils.hasText(System.getProperty("bomPath"))); - - String bomPath = System.getProperty("bomPath"); - String starterParentPath = System.getProperty("starterParentPath"); - String repoUrl = System.getProperty("repoUrl"); - String unzippedDocs = System.getProperty("unzippedDocs"); - String generatedTrainDocs = System.getProperty("generatedTrainDocs"); - - GenerateReleaseTrainDocs.main(bomPath, starterParentPath, repoUrl, unzippedDocs, generatedTrainDocs); - - BDDAssertions.then(new File(generatedTrainDocs)).isNotEmptyDirectory(); - } - -} diff --git a/train-docs/src/test/java/org/springframework/cloud/internal/ZipCategoryTests.java b/train-docs/src/test/java/org/springframework/cloud/internal/ZipCategoryTests.java deleted file mode 100644 index 49c675f4..00000000 --- a/train-docs/src/test/java/org/springframework/cloud/internal/ZipCategoryTests.java +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright 2013-2020 the original author or authors. - * - * 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. - */ - -package org.springframework.cloud.internal; - -import java.io.File; -import java.nio.file.Files; - -import org.assertj.core.api.BDDAssertions; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; - -class ZipCategoryTests { - - @Test - void should_unzip_a_file_to_the_specified_location() throws Exception { - // given: - File zipFile = new File(ZipCategoryTests.class.getClassLoader().getResource("file.zip").toURI()); - File tempDir = Files.createTempDirectory("foo").toFile(); - tempDir.deleteOnExit(); - // when: - ZipCategory.unzipTo(zipFile, tempDir); - // then: - BDDAssertions.then(tempDir.listFiles()).hasOnlyOneElementSatisfying(file -> { - BDDAssertions.then(file).hasName("file.txt").hasContent("test"); - }); - } - - @Test - void should_not_allow_malicious_traversal() throws Exception { - // given: - File zipFile = new File( - ZipCategoryTests.class.getClassLoader().getResource("zip/zip-malicious-traversal.zip").toURI()); - File tempDir = Files.createTempDirectory("foo").toFile(); - tempDir.deleteOnExit(); - // when: - try { - ZipCategory.unzipTo(zipFile, tempDir); - Assertions.fail("Should throw exception"); - } - catch (Exception e) { - BDDAssertions.then(e.getCause()).hasMessageContaining("is trying to leave the target output directory"); - } - } - -} diff --git a/train-docs/src/test/resources/file.zip b/train-docs/src/test/resources/file.zip deleted file mode 100644 index 3da3a912..00000000 Binary files a/train-docs/src/test/resources/file.zip and /dev/null differ diff --git a/train-docs/src/test/resources/logback.xml b/train-docs/src/test/resources/logback.xml deleted file mode 100644 index 96d75b75..00000000 --- a/train-docs/src/test/resources/logback.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - diff --git a/train-docs/src/test/resources/test/commons-only.xml b/train-docs/src/test/resources/test/commons-only.xml deleted file mode 100644 index c7931a42..00000000 --- a/train-docs/src/test/resources/test/commons-only.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - 4.0.0 - - org.springframework.cloud - spring-cloud-dependencies-parent - 3.0.0-SNAPSHOT - - - spring-cloud-dependencies - 2020.0.0-SNAPSHOT - spring-cloud-dependencies - Spring Cloud Dependencies - pom - - ${basedir}/../.. - 3.0.0-SNAPSHOT - - - - - - org.springframework.cloud - spring-cloud-commons-dependencies - ${spring-cloud-commons.version} - pom - import - - - org.springframework.cloud - spring-cloud-netflix-dependencies - ${spring-cloud-netflix.version} - pom - import - - - org.springframework.cloud - spring-cloud-stream-dependencies - ${spring-cloud-stream.version} - pom - import - - - org.springframework.cloud - spring-cloud-task-dependencies - ${spring-cloud-task.version} - pom - import - - - org.springframework.cloud - spring-cloud-circuitbreaker-dependencies - ${spring-cloud-circuitbreaker.version} - pom - import - - - org.springframework.cloud - spring-cloud-config-dependencies - ${spring-cloud-config.version} - pom - import - - - org.springframework.cloud - spring-cloud-function-dependencies - ${spring-cloud-function.version} - pom - import - - - org.springframework.cloud - spring-cloud-gateway-dependencies - ${spring-cloud-gateway.version} - pom - import - - - org.springframework.cloud - spring-cloud-consul-dependencies - ${spring-cloud-consul.version} - pom - import - - - org.springframework.cloud - spring-cloud-vault-dependencies - ${spring-cloud-vault.version} - pom - import - - - org.springframework.cloud - spring-cloud-zookeeper-dependencies - ${spring-cloud-zookeeper.version} - pom - import - - - org.springframework.cloud - spring-cloud-bus-dependencies - ${spring-cloud-bus.version} - pom - import - - - org.springframework.cloud - spring-cloud-contract-dependencies - ${spring-cloud-contract.version} - pom - import - - - org.springframework.cloud - spring-cloud-openfeign-dependencies - ${spring-cloud-openfeign.version} - pom - import - - - org.springframework.cloud - spring-cloud-kubernetes-dependencies - ${spring-cloud-kubernetes.version} - pom - import - - - - - - - org.codehaus.mojo - flatten-maven-plugin - false - - - - flatten - process-resources - - flatten - - - true - bom - - expand - keep - keep - remove - - - - - flatten-clean - clean - - clean - - - - - - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - diff --git a/train-docs/src/test/resources/test/pom.xml b/train-docs/src/test/resources/test/pom.xml deleted file mode 100644 index 2d1a3293..00000000 --- a/train-docs/src/test/resources/test/pom.xml +++ /dev/null @@ -1,229 +0,0 @@ - - - 4.0.0 - - org.springframework.cloud - spring-cloud-dependencies-parent - 4.1.0-SNAPSHOT - - - spring-cloud-dependencies - 2023.0.0-SNAPSHOT - spring-cloud-dependencies - Spring Cloud Dependencies - pom - - ${basedir}/../.. - 2.2.3.RELEASE - 2.3.1.RELEASE - 2.2.4.RELEASE - 1.0.4.RELEASE - 2.2.4.RELEASE - 2.2.4.RELEASE - 2.2.4.RELEASE - 3.0.8.RELEASE - 2.2.4.RELEASE - 1.1.4.RELEASE - 2.2.4.RELEASE - 2.2.4.RELEASE - 2.2.3.RELEASE - 2.2.4.RELEASE - 2.2.3.RELEASE - - - - - - org.springframework.cloud - spring-cloud-commons-dependencies - ${spring-cloud-commons.version} - pom - import - - - org.springframework.cloud - spring-cloud-netflix-dependencies - ${spring-cloud-netflix.version} - pom - import - - - org.springframework.cloud - spring-cloud-stream-dependencies - ${spring-cloud-stream.version} - pom - import - - - org.springframework.cloud - spring-cloud-task-dependencies - ${spring-cloud-task.version} - pom - import - - - org.springframework.cloud - spring-cloud-circuitbreaker-dependencies - ${spring-cloud-circuitbreaker.version} - pom - import - - - org.springframework.cloud - spring-cloud-config-dependencies - ${spring-cloud-config.version} - pom - import - - - org.springframework.cloud - spring-cloud-function-dependencies - ${spring-cloud-function.version} - pom - import - - - org.springframework.cloud - spring-cloud-gateway-dependencies - ${spring-cloud-gateway.version} - pom - import - - - org.springframework.cloud - spring-cloud-consul-dependencies - ${spring-cloud-consul.version} - pom - import - - - org.springframework.cloud - spring-cloud-vault-dependencies - ${spring-cloud-vault.version} - pom - import - - - org.springframework.cloud - spring-cloud-zookeeper-dependencies - ${spring-cloud-zookeeper.version} - pom - import - - - org.springframework.cloud - spring-cloud-bus-dependencies - ${spring-cloud-bus.version} - pom - import - - - org.springframework.cloud - spring-cloud-contract-dependencies - ${spring-cloud-contract.version} - pom - import - - - org.springframework.cloud - spring-cloud-openfeign-dependencies - ${spring-cloud-openfeign.version} - pom - import - - - org.springframework.cloud - spring-cloud-kubernetes-dependencies - ${spring-cloud-kubernetes.version} - pom - import - - - - - - - org.codehaus.mojo - flatten-maven-plugin - false - - - - flatten - process-resources - - flatten - - - true - bom - - expand - keep - keep - remove - - - - - flatten-clean - clean - - clean - - - - - - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - diff --git a/train-docs/src/test/resources/test/starter-pom.xml b/train-docs/src/test/resources/test/starter-pom.xml deleted file mode 100644 index d8c18b95..00000000 --- a/train-docs/src/test/resources/test/starter-pom.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - 4.0.0 - - org.springframework.boot - spring-boot-starter-parent - 2.4.1 - - org.springframework.cloud - spring-cloud-starter-parent - 2020.0.0-SNAPSHOT - spring-cloud-starter-parent - Spring Cloud Starter Parent - pom - https://projects.spring.io/spring-cloud - - Pivotal Software, Inc. - https://www.spring.io - - - ${basedir}/../.. - 2020.0.0-SNAPSHOT - - - - - org.springframework.cloud - spring-cloud-dependencies - ${spring-cloud.version} - pom - import - - - - - https://github.com/spring-cloud - - spring-docs - - scp://static.springframework.org/var/www/domains/springframework.org/static/htdocs/spring-cloud/docs/${project.artifactId}/${project.version} - - - - repo.spring.io - Spring Release Repository - https://repo.spring.io/libs-release-local - - - repo.spring.io - Spring Snapshot Repository - https://repo.spring.io/libs-snapshot-local - - - - - spring - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - false - - - - - - spring-snapshots - Spring Snapshots - https://repo.spring.io/libs-snapshot-local - - true - - - - spring-milestones - Spring Milestones - https://repo.spring.io/libs-milestone-local - - false - - - - - - milestone - - - repo.spring.io - Spring Milestone Repository - https://repo.spring.io/libs-milestone-local - - - - - bintray - - - bintray - Jcenter Repository - https://api.bintray.com/maven/spring/jars/org.springframework.cloud:${bintray.package} - - - - - central - - - - org.apache.maven.plugins - maven-gpg-plugin - - - sign-artifacts - verify - - sign - - - - - - - - - sonatype-nexus-snapshots - Sonatype Nexus Snapshots - https://oss.sonatype.org/content/repositories/snapshots/ - - - sonatype-nexus-staging - Nexus Release Repository - https://oss.sonatype.org/service/local/staging/deploy/maven2/ - - - - - diff --git a/train-docs/src/test/resources/zip/zip-malicious-traversal.zip b/train-docs/src/test/resources/zip/zip-malicious-traversal.zip deleted file mode 100644 index 38b3f499..00000000 Binary files a/train-docs/src/test/resources/zip/zip-malicious-traversal.zip and /dev/null differ