Rob Winch
3 years ago
11 changed files with 628 additions and 0 deletions
@ -0,0 +1,42 @@ |
|||||||
|
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: read-all |
||||||
|
jobs: |
||||||
|
build: |
||||||
|
if: github.repository_owner == 'spring-projects' |
||||||
|
runs-on: ubuntu-latest |
||||||
|
steps: |
||||||
|
- name: Checkout |
||||||
|
uses: actions/checkout@v3 |
||||||
|
with: |
||||||
|
fetch-depth: 5 |
||||||
|
- name: Set Up Gradle |
||||||
|
uses: spring-io/spring-gradle-build-action@v2 |
||||||
|
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 }} |
||||||
|
echo BUILD_REFNAME=${{ github.event.inputs.build-refname }} >> $GITHUB_ENV |
||||||
|
echo BUILD_VERSION=$(git cat-file --textconv FETCH_HEAD:gradle.properties | sed -n '/^version=/ { s/^version=//;p }') >> $GITHUB_ENV |
||||||
|
- name: Run Antora |
||||||
|
run: ./gradlew antora |
||||||
|
- name: Publish Docs |
||||||
|
uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.5 |
||||||
|
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 }} |
||||||
@ -0,0 +1,6 @@ |
|||||||
|
# Use sdkman to run "sdk env" to initialize with correct JDK version |
||||||
|
# Enable auto-env through the sdkman_auto_env config |
||||||
|
# See https://sdkman.io/usage#config |
||||||
|
# A summary is to add the following to ~/.sdkman/etc/config |
||||||
|
# sdkman_auto_env=true |
||||||
|
java=17.0.3-tem |
||||||
@ -0,0 +1,140 @@ |
|||||||
|
= Spring Framework 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. |
||||||
|
|
||||||
|
The Spring Framework 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. |
||||||
|
|
||||||
|
== Overview |
||||||
|
|
||||||
|
To prepare your system for building the documentation, <<prerequisites,install the prerequisites>> and then <<build-main,create your workspace and build the main branch documentation>>. |
||||||
|
Once you've completed those steps, follow the instructions in <<build-branch,Build the 6.0.x branch documentation>> to learn how to build the documentation for a version branch you haven't previously checked out. |
||||||
|
|
||||||
|
To build the production site documentation on your computer, follow the instructions in <<prerequisites,Prerequisites>>, <<build-main,Build the main branch documentation>>, and then <<build-production,Build the production documentation site>>. |
||||||
|
|
||||||
|
.Branch checkout instead of worktrees |
||||||
|
[NOTE] |
||||||
|
==== |
||||||
|
If you prefer to set up your workspace without worktrees, complete the steps in <<prerequisites,Prerequisites>> and clone the project repository onto your computer. |
||||||
|
Then follow the instructions in each section starting from the `sdk env || sdk env install` step once you've checked out the desired branch. |
||||||
|
==== |
||||||
|
|
||||||
|
[#prerequisites] |
||||||
|
== Prerequisites (everyone) |
||||||
|
|
||||||
|
These instructions assume you already have basic tools on your system, including bash, zip, unzip, git, and curl. |
||||||
|
In addition to these basic tools, you need https://sdkman.io/install[SDKMAN!] installed so that the correct JDK is set for each branch. |
||||||
|
|
||||||
|
. Open your terminal and enter the following command: |
||||||
|
+ |
||||||
|
-- |
||||||
|
$ curl -s "https://get.sdkman.io" | bash |
||||||
|
|
||||||
|
This command downloads and installs SDKMAN! |
||||||
|
Once installation is complete, you should see a command displayed in your terminal that will initiate SDKMAN. |
||||||
|
-- |
||||||
|
|
||||||
|
. Copy the command displayed in your terminal and run it. |
||||||
|
`$HOME` is the path unique to your computer (e.g., _home/my-jam/.sdkman/bin/sdkman-init.sh_). |
||||||
|
|
||||||
|
$ source "$HOME/.sdkman/bin/sdkman-init.sh" |
||||||
|
|
||||||
|
You'll use SDKMAN in the next sections to install and switch to the JDK required for each branch. |
||||||
|
Now you're ready to <<build-main,create your workspace>>. |
||||||
|
|
||||||
|
[#build-main] |
||||||
|
== Build the main branch documentation (writers) |
||||||
|
|
||||||
|
Your workspace will be the folder that contains the git worktrees of the project. |
||||||
|
|
||||||
|
. In your terminal, create a directory for the project and then change into that directory. |
||||||
|
|
||||||
|
$ mkdir spring-framework |
||||||
|
$ cd spring-framework |
||||||
|
|
||||||
|
. Clone the project repository and create the primary worktree for the main branch. |
||||||
|
Then change into the new _main_ folder. |
||||||
|
|
||||||
|
$ git clone https://github.com/spring-projects/spring-framework main |
||||||
|
$ cd main |
||||||
|
|
||||||
|
. Switch to the required JDK using SDKMAN by running the following command: |
||||||
|
+ |
||||||
|
-- |
||||||
|
$ sdk env || sdk env install |
||||||
|
|
||||||
|
SDKMAN will switch to the required JDK or install it if it isn't present. |
||||||
|
-- |
||||||
|
|
||||||
|
. Generate the documentation with Antora using the following command: |
||||||
|
+ |
||||||
|
-- |
||||||
|
$ ./gradlew -PbuildSrc.skipTests=true :framework-docs:antora |
||||||
|
|
||||||
|
This command will build the documentation, including any generated attributes, for the main branch. |
||||||
|
-- |
||||||
|
|
||||||
|
. Navigate to _$HOME/spring-framework/main/framework-docs/build/site/index.html_ to view the generated documentation. |
||||||
|
|
||||||
|
[#build-branch] |
||||||
|
== Build the 6.0.x branch documentation (writers) |
||||||
|
|
||||||
|
NOTE: The instructions in this section assume you've completed the steps in the <<build-main,previous section>>. |
||||||
|
|
||||||
|
After creating the worktree for the main branch, you can set up a worktree for any other branches you'll work on in the future. |
||||||
|
In this section, you'll create a worktree for the 6.0.x branch in your project workspace. |
||||||
|
|
||||||
|
. To add a worktree, you have to be in a worktree. |
||||||
|
In your terminal, change to the _main_ folder if you aren't already in it, e.g., _$HOME/spring-framework/main_. |
||||||
|
Set up a worktree for the 6.0.x branch and then change into the new directory by running the following commands: |
||||||
|
|
||||||
|
$ git worktree add ../6.0.x 6.0.x --track |
||||||
|
$ cd ../6.0.x |
||||||
|
|
||||||
|
. Switch to the required JDK or install it. |
||||||
|
|
||||||
|
$ sdk env || sdk env install |
||||||
|
|
||||||
|
. Generate the documentation with the following command: |
||||||
|
+ |
||||||
|
-- |
||||||
|
$ ./gradlew -PbuildSrc.skipTests=true :framework-docs:antora |
||||||
|
|
||||||
|
This command will build the documentation, including any generated attributes, for the 6.0.x branch. |
||||||
|
-- |
||||||
|
|
||||||
|
. Navigate to _$HOME/spring-framework/6.0.x/docs/build/site/index.html_ to view the generated documentation. |
||||||
|
|
||||||
|
[#build-production] |
||||||
|
== Build the production documentation site (docs manager) |
||||||
|
|
||||||
|
NOTE: The instructions in this section assume you've <<build-main,prepared your workspace and created the worktree for the main branch>>. |
||||||
|
|
||||||
|
To build the project's production site, you'll set up a worktree for the docs-build branch of the repository. |
||||||
|
|
||||||
|
. To add a worktree, you have to be in a worktree. |
||||||
|
In your terminal, change to the _main_ folder if you aren't already in it, e.g., _$HOME/spring-framework/main_. |
||||||
|
Run the following command to set up the worktree for the _docs-build_ branch. |
||||||
|
Then change into the new _docs-build_ directory. |
||||||
|
|
||||||
|
$ git worktree add ../docs-build docs-build --track |
||||||
|
$ cd ../docs-build |
||||||
|
|
||||||
|
. Switch to the required JDK or install it. |
||||||
|
|
||||||
|
$ sdk env || sdk env install |
||||||
|
|
||||||
|
. Generate the documentation for the project's production site using the following command: |
||||||
|
+ |
||||||
|
-- |
||||||
|
$ ./gradlew antora |
||||||
|
|
||||||
|
This command will build all of the documentation included in the project's production site from the repository on GitHub. |
||||||
|
|
||||||
|
To build the documentation from the current clone, using any worktrees that are available, use the following command instead: |
||||||
|
|
||||||
|
$ ./gradlew antora --playbook local-antora-playbook.yml |
||||||
|
-- |
||||||
|
|
||||||
|
. Navigate to _$HOME/spring-framework/docs-site/build/site/index.html_ to view the generated documentation. |
||||||
@ -0,0 +1,39 @@ |
|||||||
|
antora: |
||||||
|
extensions: |
||||||
|
- '@antora/collector-extension' |
||||||
|
- '@antora/atlas-extension' |
||||||
|
- '@opendevise/antora-release-line-extension' |
||||||
|
- '@springio/antora-extensions/latest-version-extension' |
||||||
|
- require: '@springio/antora-extensions/root-component-extension' |
||||||
|
root_component_name: 'framework' |
||||||
|
site: |
||||||
|
title: Spring Framework |
||||||
|
url: https://docs.spring.io/spring-security/reference |
||||||
|
robots: allow |
||||||
|
git: |
||||||
|
ensure_git_suffix: false |
||||||
|
content: |
||||||
|
sources: |
||||||
|
- url: https://github.com/rwinch/spring-framework |
||||||
|
branches: [6.0.x] |
||||||
|
start_path: framework-docs |
||||||
|
asciidoc: |
||||||
|
extensions: |
||||||
|
- '@asciidoctor/tabs' |
||||||
|
- '@springio/asciidoctor-extensions' |
||||||
|
- '@springio/asciidoctor-extensions/include-code-extension' |
||||||
|
attributes: |
||||||
|
page-pagination: '' |
||||||
|
hide-uri-scheme: '@' |
||||||
|
include-java: 'example$docs-src/main/java/org/springframework/docs' |
||||||
|
urls: |
||||||
|
latest_version_segment_strategy: redirect:to |
||||||
|
latest_version_segment: '' |
||||||
|
redirect_facility: httpd |
||||||
|
runtime: |
||||||
|
log: |
||||||
|
failure_level: warn |
||||||
|
ui: |
||||||
|
bundle: |
||||||
|
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.2.2/ui-bundle.zip |
||||||
|
snapshot: true |
||||||
@ -0,0 +1,23 @@ |
|||||||
|
plugins { |
||||||
|
id 'base' |
||||||
|
id 'org.antora' version '1.0.0' |
||||||
|
} |
||||||
|
|
||||||
|
antora { |
||||||
|
version = '3.2.0-alpha.2' |
||||||
|
options = ['--clean', '--fetch', '--stacktrace'] |
||||||
|
environment = [ |
||||||
|
'ALGOLIA_API_KEY': '042f6aaab6ce998d2ea29e60167e1660', |
||||||
|
'ALGOLIA_APP_ID': 'WB1FQYI187', |
||||||
|
'ALGOLIA_INDEX_NAME': 'springframework' |
||||||
|
] |
||||||
|
// NOTE remember to update the versions in lib/antora/templates/per-branch-antora-playbook.yml as well |
||||||
|
dependencies = [ |
||||||
|
'@antora/atlas-extension': '1.0.0-alpha.1', |
||||||
|
'@antora/collector-extension': '1.0.0-alpha.3', |
||||||
|
'@asciidoctor/tabs': '1.0.0-beta.3', |
||||||
|
'@opendevise/antora-release-line-extension': '1.0.0', |
||||||
|
'@springio/antora-extensions': '1.3.0', |
||||||
|
'@springio/asciidoctor-extensions': '1.0.0-alpha.9', |
||||||
|
] |
||||||
|
} |
||||||
@ -0,0 +1,2 @@ |
|||||||
|
group=org.springframework |
||||||
|
description=Spring Framework Docs Site |
||||||
Binary file not shown.
@ -0,0 +1,5 @@ |
|||||||
|
distributionBase=GRADLE_USER_HOME |
||||||
|
distributionPath=wrapper/dists |
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip |
||||||
|
zipStoreBase=GRADLE_USER_HOME |
||||||
|
zipStorePath=wrapper/dists |
||||||
@ -0,0 +1,240 @@ |
|||||||
|
#!/bin/sh |
||||||
|
|
||||||
|
# |
||||||
|
# Copyright © 2015-2021 the original 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. |
||||||
|
# |
||||||
|
|
||||||
|
############################################################################## |
||||||
|
# |
||||||
|
# Gradle start up script for POSIX generated by Gradle. |
||||||
|
# |
||||||
|
# Important for running: |
||||||
|
# |
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is |
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or |
||||||
|
# bash, then to run this script, type that shell name before the whole |
||||||
|
# command line, like: |
||||||
|
# |
||||||
|
# ksh Gradle |
||||||
|
# |
||||||
|
# Busybox and similar reduced shells will NOT work, because this script |
||||||
|
# requires all of these POSIX shell features: |
||||||
|
# * functions; |
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», |
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»; |
||||||
|
# * compound commands having a testable exit status, especially «case»; |
||||||
|
# * various built-in commands including «command», «set», and «ulimit». |
||||||
|
# |
||||||
|
# Important for patching: |
||||||
|
# |
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided |
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided. |
||||||
|
# |
||||||
|
# The "traditional" practice of packing multiple parameters into a |
||||||
|
# space-separated string is a well documented source of bugs and security |
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating |
||||||
|
# options in "$@", and eventually passing that to Java. |
||||||
|
# |
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, |
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; |
||||||
|
# see the in-line comments for details. |
||||||
|
# |
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin, |
||||||
|
# Darwin, MinGW, and NonStop. |
||||||
|
# |
||||||
|
# (3) This script is generated from the Groovy template |
||||||
|
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt |
||||||
|
# within the Gradle project. |
||||||
|
# |
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/. |
||||||
|
# |
||||||
|
############################################################################## |
||||||
|
|
||||||
|
# Attempt to set APP_HOME |
||||||
|
|
||||||
|
# Resolve links: $0 may be a link |
||||||
|
app_path=$0 |
||||||
|
|
||||||
|
# Need this for daisy-chained symlinks. |
||||||
|
while |
||||||
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path |
||||||
|
[ -h "$app_path" ] |
||||||
|
do |
||||||
|
ls=$( ls -ld "$app_path" ) |
||||||
|
link=${ls#*' -> '} |
||||||
|
case $link in #( |
||||||
|
/*) app_path=$link ;; #( |
||||||
|
*) app_path=$APP_HOME$link ;; |
||||||
|
esac |
||||||
|
done |
||||||
|
|
||||||
|
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit |
||||||
|
|
||||||
|
APP_NAME="Gradle" |
||||||
|
APP_BASE_NAME=${0##*/} |
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. |
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' |
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value. |
||||||
|
MAX_FD=maximum |
||||||
|
|
||||||
|
warn () { |
||||||
|
echo "$*" |
||||||
|
} >&2 |
||||||
|
|
||||||
|
die () { |
||||||
|
echo |
||||||
|
echo "$*" |
||||||
|
echo |
||||||
|
exit 1 |
||||||
|
} >&2 |
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false'). |
||||||
|
cygwin=false |
||||||
|
msys=false |
||||||
|
darwin=false |
||||||
|
nonstop=false |
||||||
|
case "$( uname )" in #( |
||||||
|
CYGWIN* ) cygwin=true ;; #( |
||||||
|
Darwin* ) darwin=true ;; #( |
||||||
|
MSYS* | MINGW* ) msys=true ;; #( |
||||||
|
NONSTOP* ) nonstop=true ;; |
||||||
|
esac |
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar |
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM. |
||||||
|
if [ -n "$JAVA_HOME" ] ; then |
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then |
||||||
|
# IBM's JDK on AIX uses strange locations for the executables |
||||||
|
JAVACMD=$JAVA_HOME/jre/sh/java |
||||||
|
else |
||||||
|
JAVACMD=$JAVA_HOME/bin/java |
||||||
|
fi |
||||||
|
if [ ! -x "$JAVACMD" ] ; then |
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME |
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the |
||||||
|
location of your Java installation." |
||||||
|
fi |
||||||
|
else |
||||||
|
JAVACMD=java |
||||||
|
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. |
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the |
||||||
|
location of your Java installation." |
||||||
|
fi |
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can. |
||||||
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then |
||||||
|
case $MAX_FD in #( |
||||||
|
max*) |
||||||
|
MAX_FD=$( ulimit -H -n ) || |
||||||
|
warn "Could not query maximum file descriptor limit" |
||||||
|
esac |
||||||
|
case $MAX_FD in #( |
||||||
|
'' | soft) :;; #( |
||||||
|
*) |
||||||
|
ulimit -n "$MAX_FD" || |
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD" |
||||||
|
esac |
||||||
|
fi |
||||||
|
|
||||||
|
# Collect all arguments for the java command, stacking in reverse order: |
||||||
|
# * args from the command line |
||||||
|
# * the main class name |
||||||
|
# * -classpath |
||||||
|
# * -D...appname settings |
||||||
|
# * --module-path (only if needed) |
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. |
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java |
||||||
|
if "$cygwin" || "$msys" ; then |
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) |
||||||
|
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) |
||||||
|
|
||||||
|
JAVACMD=$( cygpath --unix "$JAVACMD" ) |
||||||
|
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh |
||||||
|
for arg do |
||||||
|
if |
||||||
|
case $arg in #( |
||||||
|
-*) false ;; # don't mess with options #( |
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath |
||||||
|
[ -e "$t" ] ;; #( |
||||||
|
*) false ;; |
||||||
|
esac |
||||||
|
then |
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" ) |
||||||
|
fi |
||||||
|
# Roll the args list around exactly as many times as the number of |
||||||
|
# args, so each arg winds up back in the position where it started, but |
||||||
|
# possibly modified. |
||||||
|
# |
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so |
||||||
|
# changing the positional parameters here affects neither the number of |
||||||
|
# iterations, nor the values presented in `arg`. |
||||||
|
shift # remove old arg |
||||||
|
set -- "$@" "$arg" # push replacement arg |
||||||
|
done |
||||||
|
fi |
||||||
|
|
||||||
|
# Collect all arguments for the java command; |
||||||
|
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of |
||||||
|
# shell script including quotes and variable substitutions, so put them in |
||||||
|
# double quotes to make sure that they get re-expanded; and |
||||||
|
# * put everything else in single quotes, so that it's not re-expanded. |
||||||
|
|
||||||
|
set -- \ |
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \ |
||||||
|
-classpath "$CLASSPATH" \ |
||||||
|
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. |
||||||
|
# |
||||||
|
# In Bash we could simply go: |
||||||
|
# |
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) && |
||||||
|
# set -- "${ARGS[@]}" "$@" |
||||||
|
# |
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we |
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any |
||||||
|
# character that might be a shell metacharacter, then use eval to reverse |
||||||
|
# that process (while maintaining the separation between arguments), and wrap |
||||||
|
# the whole thing up as a single "set" statement. |
||||||
|
# |
||||||
|
# This will of course break if any of these variables contains a newline or |
||||||
|
# an unmatched quote. |
||||||
|
# |
||||||
|
|
||||||
|
eval "set -- $( |
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | |
||||||
|
xargs -n1 | |
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | |
||||||
|
tr '\n' ' ' |
||||||
|
)" '"$@"' |
||||||
|
|
||||||
|
exec "$JAVACMD" "$@" |
||||||
@ -0,0 +1,91 @@ |
|||||||
|
@rem |
||||||
|
@rem Copyright 2015 the original author or authors. |
||||||
|
@rem |
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License"); |
||||||
|
@rem you may not use this file except in compliance with the License. |
||||||
|
@rem You may obtain a copy of the License at |
||||||
|
@rem |
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0 |
||||||
|
@rem |
||||||
|
@rem Unless required by applicable law or agreed to in writing, software |
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
@rem See the License for the specific language governing permissions and |
||||||
|
@rem limitations under the License. |
||||||
|
@rem |
||||||
|
|
||||||
|
@if "%DEBUG%"=="" @echo off |
||||||
|
@rem ########################################################################## |
||||||
|
@rem |
||||||
|
@rem Gradle startup script for Windows |
||||||
|
@rem |
||||||
|
@rem ########################################################################## |
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell |
||||||
|
if "%OS%"=="Windows_NT" setlocal |
||||||
|
|
||||||
|
set DIRNAME=%~dp0 |
||||||
|
if "%DIRNAME%"=="" set DIRNAME=. |
||||||
|
set APP_BASE_NAME=%~n0 |
||||||
|
set APP_HOME=%DIRNAME% |
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter. |
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi |
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. |
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" |
||||||
|
|
||||||
|
@rem Find java.exe |
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome |
||||||
|
|
||||||
|
set JAVA_EXE=java.exe |
||||||
|
%JAVA_EXE% -version >NUL 2>&1 |
||||||
|
if %ERRORLEVEL% equ 0 goto execute |
||||||
|
|
||||||
|
echo. |
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. |
||||||
|
echo. |
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the |
||||||
|
echo location of your Java installation. |
||||||
|
|
||||||
|
goto fail |
||||||
|
|
||||||
|
:findJavaFromJavaHome |
||||||
|
set JAVA_HOME=%JAVA_HOME:"=% |
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe |
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute |
||||||
|
|
||||||
|
echo. |
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% |
||||||
|
echo. |
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the |
||||||
|
echo location of your Java installation. |
||||||
|
|
||||||
|
goto fail |
||||||
|
|
||||||
|
:execute |
||||||
|
@rem Setup the command line |
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar |
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle |
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* |
||||||
|
|
||||||
|
:end |
||||||
|
@rem End local scope for the variables with windows NT shell |
||||||
|
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! |
||||||
|
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 |
||||||
|
|
||||||
|
:omega |
||||||
@ -0,0 +1,40 @@ |
|||||||
|
# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.3.0 @asciidoctor/tabs@1.0.0-beta.3 @springio/asciidoctor-extensions @opendevise/antora-release-line-extension@1.0.0 |
||||||
|
# |
||||||
|
# The purpose of this Antora playbook is to build the docs in the current branch. |
||||||
|
antora: |
||||||
|
extensions: |
||||||
|
- '@antora/collector-extension' |
||||||
|
- id: '@antora/atlas-extension' |
||||||
|
require: '@antora/atlas-extension' |
||||||
|
enabled: false |
||||||
|
- '@springio/antora-extensions/latest-version-extension' |
||||||
|
- require: '@springio/antora-extensions/root-component-extension' |
||||||
|
root_component_name: 'framework' |
||||||
|
site: |
||||||
|
title: Spring Framework Reference |
||||||
|
content: |
||||||
|
sources: |
||||||
|
- url: ./.. |
||||||
|
branches: HEAD |
||||||
|
start_path: framework-docs |
||||||
|
worktrees: true |
||||||
|
asciidoc: |
||||||
|
attributes: |
||||||
|
hide-uri-scheme: '@' |
||||||
|
page-pagination: '' |
||||||
|
primary-site-url: https://docs.spring.io/spring-framework/reference |
||||||
|
tabs-sync-option: '@' |
||||||
|
extensions: |
||||||
|
- '@asciidoctor/tabs' |
||||||
|
- '@springio/asciidoctor-extensions' |
||||||
|
- '@springio/asciidoctor-extensions/include-code-extension' |
||||||
|
sourcemap: true |
||||||
|
urls: |
||||||
|
latest_version_segment: '' |
||||||
|
runtime: |
||||||
|
log: |
||||||
|
failure_level: warn |
||||||
|
ui: |
||||||
|
bundle: |
||||||
|
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.2.2/ui-bundle.zip |
||||||
|
snapshot: true |
||||||
Loading…
Reference in new issue