Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update broken links, correct gradle command for Windows OS. #12336

Closed
wants to merge 3 commits into from
Closed

Update broken links, correct gradle command for Windows OS. #12336

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc0ab02
Correct content of guide.
donhuvy Dec 4, 2022
b4ad369
Update README.adoc
donhuvy Dec 4, 2022
ca5ea4b
Remove link of Gradle task - build for release
donhuvy Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked fr
a cross-platform, self-contained bootstrap mechanism for the build.

=== Prerequisites
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK17 build].
https://docs.github.com/en/get-started/quickstart/set-up-git[Git] and the https://www.oracle.com/java/technologies/downloads/#java17[JDK17 build].

Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder extracted from the JDK download.

Expand All @@ -40,37 +40,58 @@ Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder
git clone [email protected]:spring-projects/spring-security.git
----

=== Install all spring-\* jars into your local Maven cache
=== Install all `spring-*.jar` into your local Maven repository.
In macOS, Linux operating system, at directory where has file `gradlew.bat` of source code, run command. If the command did not work as expected, set execute permission for `gradlew`.

[indent=0]
----
./gradlew publishToMavenLocal
----

=== Compile and test; build all jars, distribution zips, and docs
In Windows operating system
[indent=0]
----
gradlew publishToMavenLocal
----


=== Compile and test; build all JARs, distribution zips, and docs
In macOS, Linux operating system
[indent=0]
----
./gradlew build
----

In Windows operating system
[indent=0]
----
gradlew build
----

The reference docs are not currently included in the distribution zip.
You can build the reference docs for this branch by running the following command:

In macOS, Linux operating system
----
./gradlew :spring-security-docs:antora
----

That command publishes the docs site to the _docs/build/site_ directory.
In Windows operating system
[indent=0]
----
gradlew :spring-security-docs:antora
----

That command publishes the docs site to the `_docs/build/site_` directory.
The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail.

Discover more commands with `./gradlew tasks`.
See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].
Discover more commands with `./gradlew tasks` in macOS/Linux (or `gradlew tasks` in Windows OS).

== Getting Support
Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
https://spring.io/services[Commercial support] is available too.

== Contributing
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details.
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details.

== License
Spring Security is Open Source software released under the
Expand Down