From 29c63bee69bbc5390ae146e841cdf60af5a5a2a9 Mon Sep 17 00:00:00 2001 From: Josh Cummings <3627351+jzheaux@users.noreply.github.com> Date: Wed, 19 Nov 2025 15:22:36 -0700 Subject: [PATCH] Stop Deploying JavaDoc Outside of Antora Closes gh-18198 --- .../continuous-integration-workflow.yml | 9 +- build.gradle | 2 +- .../gradle/convention/DeployDocsPlugin.groovy | 82 ------------------- .../gradle/convention/DocsPlugin.groovy | 1 - .../resources/samples/showcase/Jenkinsfile | 12 +-- 5 files changed, 3 insertions(+), 103 deletions(-) delete mode 100644 buildSrc/src/main/groovy/io/spring/gradle/convention/DeployDocsPlugin.groovy diff --git a/.github/workflows/continuous-integration-workflow.yml b/.github/workflows/continuous-integration-workflow.yml index 23cdae4f8c..97fd44d85a 100644 --- a/.github/workflows/continuous-integration-workflow.yml +++ b/.github/workflows/continuous-integration-workflow.yml @@ -71,13 +71,6 @@ jobs: with: should-deploy-artifacts: ${{ needs.build.outputs.should-deploy-artifacts }} secrets: inherit - deploy-docs: - name: Deploy Docs - needs: [ build, test, check-samples ] - uses: spring-io/spring-security-release-tools/.github/workflows/deploy-docs.yml@v1 - with: - should-deploy-docs: ${{ needs.build.outputs.should-deploy-artifacts }} - secrets: inherit deploy-schema: name: Deploy Schema needs: [ build, test, check-samples ] @@ -87,7 +80,7 @@ jobs: secrets: inherit perform-release: name: Perform Release - needs: [ deploy-artifacts, deploy-docs, deploy-schema ] + needs: [ deploy-artifacts, deploy-schema ] uses: spring-io/spring-security-release-tools/.github/workflows/perform-release.yml@v1 with: should-perform-release: ${{ needs.deploy-artifacts.outputs.artifacts-deployed }} diff --git a/build.gradle b/build.gradle index aee7383986..1f64875227 100644 --- a/build.gradle +++ b/build.gradle @@ -42,7 +42,7 @@ springRelease { weekOfMonth = 3 dayOfWeek = 1 referenceDocUrl = "https://docs.spring.io/spring-security/reference/{version}/index.html" - apiDocUrl = "https://docs.spring.io/spring-security/site/docs/{version}/api/" + apiDocUrl = "https://docs.spring.io/spring-security/reference/{version}/api/java/index.html" replaceSnapshotVersionInReferenceDocUrl = true } diff --git a/buildSrc/src/main/groovy/io/spring/gradle/convention/DeployDocsPlugin.groovy b/buildSrc/src/main/groovy/io/spring/gradle/convention/DeployDocsPlugin.groovy deleted file mode 100644 index 84648f48d1..0000000000 --- a/buildSrc/src/main/groovy/io/spring/gradle/convention/DeployDocsPlugin.groovy +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Copyright 2004-present 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 io.spring.gradle.convention - -import org.gradle.api.plugins.JavaPlugin -import org.gradle.api.tasks.bundling.Zip -import org.gradle.api.Plugin -import org.gradle.api.Project - -public class DeployDocsPlugin implements Plugin { - - @Override - public void apply(Project project) { - project.getPluginManager().apply('org.hidetake.ssh') - - project.ssh.settings { - knownHosts = allowAnyHosts - } - project.remotes { - docs { - role 'docs' - if (project.hasProperty('deployDocsHost')) { - host = project.findProperty('deployDocsHost') - } else { - host = 'docs.af.pivotal.io' - } - retryCount = 5 // retry 5 times (default is 0) - retryWaitSec = 10 // wait 10 seconds between retries (default is 0) - user = project.findProperty('deployDocsSshUsername') - if (project.hasProperty('deployDocsSshKeyPath')) { - identity = project.file(project.findProperty('deployDocsSshKeyPath')) - } else if (project.hasProperty('deployDocsSshKey')) { - identity = project.findProperty('deployDocsSshKey') - } - if(project.hasProperty('deployDocsSshPassphrase')) { - passphrase = project.findProperty('deployDocsSshPassphrase') - } - } - } - - project.task('deployDocs') { - dependsOn 'docsZip' - doFirst { - project.ssh.run { - session(project.remotes.docs) { - def now = System.currentTimeMillis() - def name = project.rootProject.name - def version = project.rootProject.version - def tempPath = "/tmp/${name}-${now}-docs/".replaceAll(' ', '_') - execute "mkdir -p $tempPath" - - project.tasks.docsZip.outputs.each { o -> - put from: o.files, into: tempPath - } - - execute "unzip $tempPath*.zip -d $tempPath" - - def extractPath = "/var/www/domains/spring.io/docs/htdocs/autorepo/docs/${name}/${version}/" - - execute "rm -rf $extractPath" - execute "mkdir -p $extractPath" - execute "mv $tempPath/docs/* $extractPath" - execute "chmod -R g+w $extractPath" - } - } - } - } - } -} diff --git a/buildSrc/src/main/groovy/io/spring/gradle/convention/DocsPlugin.groovy b/buildSrc/src/main/groovy/io/spring/gradle/convention/DocsPlugin.groovy index c62fef79b1..318fb24f73 100644 --- a/buildSrc/src/main/groovy/io/spring/gradle/convention/DocsPlugin.groovy +++ b/buildSrc/src/main/groovy/io/spring/gradle/convention/DocsPlugin.groovy @@ -17,7 +17,6 @@ public class DocsPlugin implements Plugin { PluginManager pluginManager = project.getPluginManager(); pluginManager.apply(BasePlugin); - pluginManager.apply(DeployDocsPlugin); pluginManager.apply(JavadocApiPlugin); Task docsZip = project.tasks.create('docsZip', Zip) { diff --git a/buildSrc/src/test/resources/samples/showcase/Jenkinsfile b/buildSrc/src/test/resources/samples/showcase/Jenkinsfile index ad9bfeaf7d..c9c6e4ab04 100644 --- a/buildSrc/src/test/resources/samples/showcase/Jenkinsfile +++ b/buildSrc/src/test/resources/samples/showcase/Jenkinsfile @@ -30,16 +30,6 @@ ossrh: { } } }, -docs: { - stage('Deploy Docs') { - node { - checkout scm - withCredentials([file(credentialsId: 'docs.spring.io-jenkins_private_ssh_key', variable: 'DEPLOY_SSH_KEY')]) { - sh "./gradlew deployDocs -PdeployDocsSshKeyPath=$DEPLOY_SSH_KEY -PdeployDocsSshUsername=$SPRING_DOCS_USERNAME --refresh-dependencies --no-daemon --stacktrace" - } - } - } -}, schema: { stage('Deploy Schema') { node { @@ -49,4 +39,4 @@ schema: { } } } -} \ No newline at end of file +}