From fa058f1333b4f80c370f695eb2c10b6e852def3f Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Tue, 6 Jun 2023 21:31:48 -0500 Subject: [PATCH] Add warning for snapshot docs If the project version is a SNAPSHOT a warning is added at the top of the docs stating this fact. --- spring-pulsar-docs/spring-pulsar-docs.gradle | 3 ++- .../src/main/asciidoc/attributes-variables.adoc | 1 + spring-pulsar-docs/src/main/asciidoc/index.adoc | 4 ++++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/spring-pulsar-docs/spring-pulsar-docs.gradle b/spring-pulsar-docs/spring-pulsar-docs.gradle index 54c624da..35a35911 100644 --- a/spring-pulsar-docs/spring-pulsar-docs.gradle +++ b/spring-pulsar-docs/spring-pulsar-docs.gradle @@ -92,7 +92,8 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) { "spring-pulsar-binder-version": project.springPulsarBinderVersion ?: 'current', "spring-pulsar-starter-version": project.springPulsarStarterVersion ?: 'current', "pulsar-client-version": project.pulsarClientVersion ?: 'current', - "pulsar-client-reactive-version": project.pulsarClientReactiveVersion ?: 'current' + "pulsar-client-reactive-version": project.pulsarClientReactiveVersion ?: 'current', + "is-snapshot-version": project.version.endsWith("-SNAPSHOT") } } diff --git a/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc b/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc index b90cce43..c1d99488 100644 --- a/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc +++ b/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc @@ -6,6 +6,7 @@ :spring-pulsar-starter-version: current :pulsar-client-version: current :pulsar-client-reactive-version: current +:is-snapshot-version: false :github: https://github.com/spring-projects/spring-pulsar :javadocs: https://docs.spring.io/spring-pulsar/docs/{spring-pulsar-version}/api diff --git a/spring-pulsar-docs/src/main/asciidoc/index.adoc b/spring-pulsar-docs/src/main/asciidoc/index.adoc index d74fb484..2b80a22b 100644 --- a/spring-pulsar-docs/src/main/asciidoc/index.adoc +++ b/spring-pulsar-docs/src/main/asciidoc/index.adoc @@ -7,6 +7,10 @@ include::authors.adoc[] include::copyright.adoc[] +ifeval::[{is-snapshot-version} == true] +CAUTION: You are viewing documentation for a SNAPSHOT version ({spring-pulsar-version}). While it is usually in-sync with the underlying code, it is subject to change and not guaranteed to be up-to-date with the underlying code. +endif::[] + include::intro.adoc[leveloffset=+1] include::getting-help.adoc[leveloffset=+2]