From 7a3b87ef8187ef42cb9ef5ca92739ac8b1bc1ea3 Mon Sep 17 00:00:00 2001 From: Jerome Prinet Date: Mon, 22 May 2023 18:28:36 +0200 Subject: [PATCH 1/4] Set asciidoctor path inputs as relative path --- docs/spring-authorization-server-docs.gradle | 3 --- docs/src/docs/asciidoc/attributes.adoc | 3 +++ docs/src/docs/asciidoc/getting-started.adoc | 2 ++ docs/src/docs/asciidoc/guides/how-to-jpa.adoc | 2 ++ docs/src/docs/asciidoc/guides/how-to-pkce.adoc | 3 ++- docs/src/docs/asciidoc/guides/how-to-social-login.adoc | 4 ++-- docs/src/docs/asciidoc/guides/how-to-userinfo.adoc | 2 ++ docs/src/docs/asciidoc/how-to.adoc | 2 ++ 8 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 docs/src/docs/asciidoc/attributes.adoc diff --git a/docs/spring-authorization-server-docs.gradle b/docs/spring-authorization-server-docs.gradle index ce3e644de..b87651844 100644 --- a/docs/spring-authorization-server-docs.gradle +++ b/docs/spring-authorization-server-docs.gradle @@ -8,9 +8,6 @@ asciidoctor { "spring-security-reference-base-url": "https://docs.spring.io/spring-security/reference", "spring-security-api-base-url": "https://docs.spring.io/spring-security/site/docs/current/api", "spring-boot-reference-base-url": "https://docs.spring.io/spring-boot/docs/current/reference/html", - "examples-dir": "examples", - "samples-dir": "$rootDir/samples", - "docs-java": "$sourceDir/examples/src/main/java", "chomp": "default headers packages", "toc": "left", "toclevels": "4" diff --git a/docs/src/docs/asciidoc/attributes.adoc b/docs/src/docs/asciidoc/attributes.adoc new file mode 100644 index 000000000..0b2744c60 --- /dev/null +++ b/docs/src/docs/asciidoc/attributes.adoc @@ -0,0 +1,3 @@ +:examples-dir: examples +:samples-dir: ../../../../samples +:docs-java: {docdir}/examples/src/main/java diff --git a/docs/src/docs/asciidoc/getting-started.adoc b/docs/src/docs/asciidoc/getting-started.adoc index 43b95f235..4c8b41786 100644 --- a/docs/src/docs/asciidoc/getting-started.adoc +++ b/docs/src/docs/asciidoc/getting-started.adoc @@ -1,3 +1,5 @@ +include::attributes.adoc[] + [[getting-started]] = Getting Started diff --git a/docs/src/docs/asciidoc/guides/how-to-jpa.adoc b/docs/src/docs/asciidoc/guides/how-to-jpa.adoc index 94feb9d74..d26498f6c 100644 --- a/docs/src/docs/asciidoc/guides/how-to-jpa.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-jpa.adoc @@ -1,3 +1,5 @@ +include::../asciidoc/attributes.adoc[] + [[how-to-jpa]] = How-to: Implement core services with JPA :index-link: ../how-to.html diff --git a/docs/src/docs/asciidoc/guides/how-to-pkce.adoc b/docs/src/docs/asciidoc/guides/how-to-pkce.adoc index ff7c040f4..0640014d7 100644 --- a/docs/src/docs/asciidoc/guides/how-to-pkce.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-pkce.adoc @@ -1,8 +1,9 @@ +include::../asciidoc/attributes.adoc[] + [[how-to-pkce]] = How-to: Authenticate using a Single Page Application with PKCE :index-link: ../how-to.html :docs-dir: .. -:examples-dir: {docs-dir}/examples This guide shows how to configure xref:{docs-dir}/index.adoc#top[Spring Authorization Server] to support a Single Page Application (SPA) with Proof Key for Code Exchange (PKCE). The purpose of this guide is to demonstrate how to support a public client and require PKCE for client authentication. diff --git a/docs/src/docs/asciidoc/guides/how-to-social-login.adoc b/docs/src/docs/asciidoc/guides/how-to-social-login.adoc index 2b07a48ee..677915ccf 100644 --- a/docs/src/docs/asciidoc/guides/how-to-social-login.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-social-login.adoc @@ -1,9 +1,9 @@ +include::../asciidoc/attributes.adoc[] + [[how-to-social-login]] = How-to: Authenticate using Social Login :index-link: ../how-to.html :docs-dir: .. -:examples-dir: {docs-dir}/examples -:samples-dir: {docs-dir}/../../../../samples :github-ref: main :github-base-url: https://github.com/spring-projects/spring-authorization-server/blob/{github-ref} diff --git a/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc b/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc index f7b8db6f0..15a92e80f 100644 --- a/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc @@ -1,3 +1,5 @@ +include::../asciidoc/attributes.adoc[] + [[how-to-userinfo]] = How-to: Customize the OpenID Connect 1.0 UserInfo response :index-link: ../how-to.html diff --git a/docs/src/docs/asciidoc/how-to.adoc b/docs/src/docs/asciidoc/how-to.adoc index a5d22d16a..29ec943c5 100644 --- a/docs/src/docs/asciidoc/how-to.adoc +++ b/docs/src/docs/asciidoc/how-to.adoc @@ -1,3 +1,5 @@ +include::attributes.adoc[] + [[how-to]] = How-to Guides From 16e541e3e3357a054f16db24a480bf825073d464 Mon Sep 17 00:00:00 2001 From: Jerome Prinet Date: Tue, 23 May 2023 14:28:12 +0200 Subject: [PATCH 2/4] Exclude examples/build from AsciiDoctorTask.sources to preserve task inputs --- .../springframework/gradle/docs/SpringAsciidoctorPlugin.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/buildSrc/src/main/java/org/springframework/gradle/docs/SpringAsciidoctorPlugin.java b/buildSrc/src/main/java/org/springframework/gradle/docs/SpringAsciidoctorPlugin.java index 5b8d3bd62..5946b8f1a 100644 --- a/buildSrc/src/main/java/org/springframework/gradle/docs/SpringAsciidoctorPlugin.java +++ b/buildSrc/src/main/java/org/springframework/gradle/docs/SpringAsciidoctorPlugin.java @@ -120,6 +120,9 @@ private void configureAsciidoctorExtension(AbstractAsciidoctorTask asciidoctorTa // Not using intermediateWorkDir. // See https://github.com/asciidoctor/asciidoctor-gradle-plugin/issues/523 resourcesSrcDirSpec.include("images/*.png", "css/**", "js/**", "**/*.java"); + // This exclusion is required to allow cacheability of :spring-authorization-server-docs:asciidoctor + // The whole docs/src/docs/asciidoc folder is being passed as a task input + resourcesSrcDirSpec.exclude("**/examples/build/**"); }); }); if (asciidoctorTask instanceof AsciidoctorTask) { From 755fc69c47a91d55656fe9a14dfe338d3292e7ea Mon Sep 17 00:00:00 2001 From: Jerome Prinet Date: Wed, 24 May 2023 15:44:01 +0200 Subject: [PATCH 3/4] Update how-to-ext-grant-type.adoc --- docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc b/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc index 6ccc13753..a08b2c135 100644 --- a/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc @@ -1,8 +1,9 @@ +include::../asciidoc/attributes.adoc[] + [[how-to-extension-grant-type]] = How-to: Implement an Extension Authorization Grant Type :index-link: ../how-to.html :docs-dir: .. -:examples-dir: {docs-dir}/examples This guide shows how to extend xref:{docs-dir}/index.adoc#top[Spring Authorization Server] with an https://datatracker.ietf.org/doc/html/rfc6749#section-4.5[extension authorization grant type]. The purpose of this guide is to demonstrate how to implement an extension authorization grant type and configure it at the xref:{docs-dir}/protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token endpoint]. From 84bd73cc5e8352cd14b960c28eb14cad0b154bf9 Mon Sep 17 00:00:00 2001 From: Jerome Prinet Date: Tue, 30 May 2023 18:26:29 +0200 Subject: [PATCH 4/4] Override asciidoc attributes in guides folder --- docs/src/docs/asciidoc/guides/attributes.adoc | 3 +++ docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc | 2 +- docs/src/docs/asciidoc/guides/how-to-jpa.adoc | 2 +- docs/src/docs/asciidoc/guides/how-to-pkce.adoc | 2 +- docs/src/docs/asciidoc/guides/how-to-social-login.adoc | 2 +- docs/src/docs/asciidoc/guides/how-to-userinfo.adoc | 2 +- 6 files changed, 8 insertions(+), 5 deletions(-) create mode 100644 docs/src/docs/asciidoc/guides/attributes.adoc diff --git a/docs/src/docs/asciidoc/guides/attributes.adoc b/docs/src/docs/asciidoc/guides/attributes.adoc new file mode 100644 index 000000000..4f8e9c7e7 --- /dev/null +++ b/docs/src/docs/asciidoc/guides/attributes.adoc @@ -0,0 +1,3 @@ +:examples-dir: ../examples +:samples-dir: ../../../../../samples +:docs-java: {docdir}/examples/src/main/java diff --git a/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc b/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc index a08b2c135..5b0d2d8b9 100644 --- a/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-ext-grant-type.adoc @@ -1,4 +1,4 @@ -include::../asciidoc/attributes.adoc[] +include::attributes.adoc[] [[how-to-extension-grant-type]] = How-to: Implement an Extension Authorization Grant Type diff --git a/docs/src/docs/asciidoc/guides/how-to-jpa.adoc b/docs/src/docs/asciidoc/guides/how-to-jpa.adoc index d26498f6c..d7355d833 100644 --- a/docs/src/docs/asciidoc/guides/how-to-jpa.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-jpa.adoc @@ -1,4 +1,4 @@ -include::../asciidoc/attributes.adoc[] +include::attributes.adoc[] [[how-to-jpa]] = How-to: Implement core services with JPA diff --git a/docs/src/docs/asciidoc/guides/how-to-pkce.adoc b/docs/src/docs/asciidoc/guides/how-to-pkce.adoc index 0640014d7..4fd497deb 100644 --- a/docs/src/docs/asciidoc/guides/how-to-pkce.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-pkce.adoc @@ -1,4 +1,4 @@ -include::../asciidoc/attributes.adoc[] +include::attributes.adoc[] [[how-to-pkce]] = How-to: Authenticate using a Single Page Application with PKCE diff --git a/docs/src/docs/asciidoc/guides/how-to-social-login.adoc b/docs/src/docs/asciidoc/guides/how-to-social-login.adoc index f80fa2920..8ccf25a01 100644 --- a/docs/src/docs/asciidoc/guides/how-to-social-login.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-social-login.adoc @@ -1,4 +1,4 @@ -include::../asciidoc/attributes.adoc[] +include::attributes.adoc[] [[how-to-social-login]] = How-to: Authenticate using Social Login diff --git a/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc b/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc index 9973badf3..c36357bda 100644 --- a/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc +++ b/docs/src/docs/asciidoc/guides/how-to-userinfo.adoc @@ -1,4 +1,4 @@ -include::../asciidoc/attributes.adoc[] +include::attributes.adoc[] [[how-to-userinfo]] = How-to: Customize the OpenID Connect 1.0 UserInfo response