switch to official Antora Plugin for Gradle

- lock version to latest release of Antora 3.1
- declare Node.js dependencies in build.gradle
- use Node.js version provided by plugin
- assign environment variables using environments property on extension block
- move group and description project properties to gradle.properties
- remove unneeded .npmrc
- upgrade to Gradle 7.5.1
- pass -q when running gradlew from Collector
This commit is contained in:
Dan Allen 2022-09-26 14:28:34 -06:00 committed by Steve Riesenberg
parent 957566ebd7
commit 649823f401
11 changed files with 27 additions and 51 deletions

2
.npmrc
View File

@ -1,2 +0,0 @@
lockfile-version=3
omit=optional

View File

@ -5,9 +5,6 @@ antora:
- '@antora/collector-extension'
- ./lib/antora/extensions/version-fix.js
- ./lib/antora/extensions/major-minor-segment.js
runtime:
log:
format: pretty
site:
title: Spring Security
url: https://docs.spring.io/spring-security/reference

View File

@ -4,9 +4,6 @@ antora:
- '@antora/collector-extension'
- ./lib/antora/extensions/version-fix.js
- ./lib/antora/extensions/major-minor-segment.js
runtime:
log:
format: pretty
site:
title: Spring Security
url: https://docs.spring.io/spring-security/reference

View File

@ -1,27 +1,16 @@
plugins {
id "io.github.rwinch.antora" version "0.0.2"
}
group = 'org.springframework.security'
description = 'Spring Security'
node {
version = "16.17.0"
id 'org.antora' version '1.0.0-alpha.3'
}
antora {
antoraVersion = "3.1.0"
arguments = ["--clean", "--fetch", "--stacktrace"]
}
tasks.antora {
version = '~3.1'
options = ['--clean', '--fetch', '--stacktrace']
environment = [
"ALGOLIA_API_KEY" : "82c7ead946afbac3cf98c32446154691",
"ALGOLIA_APP_ID" : "244V8V9FGG",
"ALGOLIA_INDEX_NAME" : "security-docs"
'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691',
'ALGOLIA_APP_ID': '244V8V9FGG',
'ALGOLIA_INDEX_NAME': 'security-docs'
]
dependencies = [
'@antora/collector-extension': '1.0.0-alpha.2'
]
}
repositories {
mavenCentral()
}

2
gradle.properties Normal file
View File

@ -0,0 +1,2 @@
group=org.springframework.security
description=Spring Security Docs Site

Binary file not shown.

View File

@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

6
gradlew vendored
View File

@ -205,6 +205,12 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.

14
gradlew.bat vendored
View File

@ -14,7 +14,7 @@
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@ -25,7 +25,7 @@
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
if "%DIRNAME%"=="" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
if %ERRORLEVEL% equ 0 goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal

View File

@ -1,6 +1,6 @@
'use strict'
const BASE_COMMAND = 'gradlew -PbuildSrc.skipTests=true'
const BASE_COMMAND = 'gradlew -q -PbuildSrc.skipTests=true'
const JVM_ARGS='-Xmx3g -XX:+HeapDumpOnOutOfMemoryError'
const REPO_URL = 'https://github.com/spring-projects/spring-security'
const TASK_NAME=':spring-security-docs:generateAntora'

View File

@ -1,15 +0,0 @@
{
"name": "spring-security-docs-site",
"description": "Spring Security Docs",
"private": true,
"dependencies": {
"@antora/cli": "^3.1.0",
"@antora/site-generator-default": "^3.1.0",
"@antora/collector-extension": "1.0.0-alpha.2"
},
"overrides": {
"vinyl-fs": {
"glob-stream": "~7.0"
}
}
}