From 45d5ecf5ffaae9715341d496dbde249dd118c92c Mon Sep 17 00:00:00 2001 From: spencergibb Date: Wed, 30 Mar 2022 15:33:05 -0400 Subject: [PATCH] Moves core/docs to root of project for compatibility Resolves https://github.com/spring-cloud/spring-cloud-stream/issues/2312 --- .../docs/src/main/asciidoc/_configprops.adoc | 5 ----- .../docs/src/main/asciidoc/_configprops.adoc | 5 ----- core/pom.xml | 16 ++++++++-------- {core/docs => docs}/.jdk8 | 0 {core/docs => docs}/pom.xml | 0 .../docs => docs}/src/main/asciidoc/README.adoc | 0 .../src/main/asciidoc/_configprops.adoc | 5 ----- .../src/main/asciidoc/binders.adoc | 0 .../docs => docs}/src/main/asciidoc/ghpages.sh | 0 .../src/main/asciidoc/images/SCSt-groups.png | Bin .../src/main/asciidoc/images/SCSt-overview.png | Bin .../main/asciidoc/images/SCSt-partitioning.png | Bin .../src/main/asciidoc/images/SCSt-sensors.png | Bin .../main/asciidoc/images/SCSt-with-binder.png | Bin .../images/custom_vs_global_error_channels.png | Bin .../asciidoc/images/producers-consumers.png | Bin .../src/main/asciidoc/images/redis-binder.png | Bin .../src/main/asciidoc/images/registration.png | Bin .../src/main/asciidoc/images/schema_reading.png | Bin .../main/asciidoc/images/schema_resolution.png | Bin .../main/asciidoc/images/spring-initializr.png | Bin .../docs => docs}/src/main/asciidoc/index.adoc | 0 .../docs => docs}/src/main/asciidoc/intro.adoc | 0 .../src/main/asciidoc/preface.adoc | 0 .../src/main/asciidoc/sagan-index.adoc | 0 .../src/main/asciidoc/spring-cloud-stream.adoc | 0 .../src/main/ruby/generate_readme.sh | 0 pom.xml | 1 + 28 files changed, 9 insertions(+), 23 deletions(-) rename {core/docs => docs}/.jdk8 (100%) rename {core/docs => docs}/pom.xml (100%) rename {core/docs => docs}/src/main/asciidoc/README.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/_configprops.adoc (81%) rename {core/docs => docs}/src/main/asciidoc/binders.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/ghpages.sh (100%) rename {core/docs => docs}/src/main/asciidoc/images/SCSt-groups.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/SCSt-overview.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/SCSt-partitioning.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/SCSt-sensors.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/SCSt-with-binder.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/custom_vs_global_error_channels.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/producers-consumers.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/redis-binder.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/registration.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/schema_reading.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/schema_resolution.png (100%) rename {core/docs => docs}/src/main/asciidoc/images/spring-initializr.png (100%) rename {core/docs => docs}/src/main/asciidoc/index.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/intro.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/preface.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/sagan-index.adoc (100%) rename {core/docs => docs}/src/main/asciidoc/spring-cloud-stream.adoc (100%) rename {core/docs => docs}/src/main/ruby/generate_readme.sh (100%) diff --git a/binders/kafka-binder/docs/src/main/asciidoc/_configprops.adoc b/binders/kafka-binder/docs/src/main/asciidoc/_configprops.adoc index 247d8f56d..c67b67ef3 100644 --- a/binders/kafka-binder/docs/src/main/asciidoc/_configprops.adoc +++ b/binders/kafka-binder/docs/src/main/asciidoc/_configprops.adoc @@ -50,11 +50,6 @@ |spring.cloud.stream.kafka.binder.transaction.producer.use-native-encoding | | |spring.cloud.stream.kafka.binder.transaction.transaction-id-prefix | | |spring.cloud.stream.kafka.bindings | | -|spring.cloud.stream.metrics.export-properties | | List of properties that are going to be appended to each message. This gets populate by onApplicationEvent, once the context refreshes to avoid overhead of doing per message basis. -|spring.cloud.stream.metrics.key | | The name of the metric being emitted. Should be an unique value per application. Defaults to: ${spring.application.name:${vcap.application.name:${spring.config.name:application}}}. -|spring.cloud.stream.metrics.meter-filter | | Pattern to control the 'meters' one wants to capture. By default all 'meters' will be captured. For example, 'spring.integration.*' will only capture metric information for meters whose name starts with 'spring.integration'. -|spring.cloud.stream.metrics.properties | | Application properties that should be added to the metrics payload For example: `spring.application**`. -|spring.cloud.stream.metrics.schedule-interval | `60s` | Interval expressed as Duration for scheduling metrics snapshots publishing. Defaults to 60 seconds |spring.cloud.stream.output-bindings | | A semi-colon delimited string to explicitly define output bindings (specifically for cases when there is no implicit trigger to create such bindings such as Function, Supplier or Consumer). |spring.cloud.stream.override-cloud-connectors | `false` | This property is only applicable when the cloud profile is active and Spring Cloud Connectors are provided with the application. If the property is false (the default), the binder detects a suitable bound service (for example, a RabbitMQ service bound in Cloud Foundry for the RabbitMQ binder) and uses it for creating connections (usually through Spring Cloud Connectors). When set to true, this property instructs binders to completely ignore the bound services and rely on Spring Boot properties (for example, relying on the spring.rabbitmq.* properties provided in the environment for the RabbitMQ binder). The typical usage of this property is to be nested in a customized environment when connecting to multiple systems. |spring.cloud.stream.pollable-source | `none` | A semi-colon delimited list of binding names of pollable sources. Binding names follow the same naming convention as functions. For example, name '...pollable-source=foobar' will be accessible as 'foobar-iin-0'' binding diff --git a/binders/rabbit-binder/docs/src/main/asciidoc/_configprops.adoc b/binders/rabbit-binder/docs/src/main/asciidoc/_configprops.adoc index 519f78ec4..f1440e19a 100644 --- a/binders/rabbit-binder/docs/src/main/asciidoc/_configprops.adoc +++ b/binders/rabbit-binder/docs/src/main/asciidoc/_configprops.adoc @@ -14,11 +14,6 @@ |spring.cloud.stream.instance-index | `0` | The instance id of the application: a number from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index" where 'foo' is the name of the binding. |spring.cloud.stream.instance-index-list | | A list of instance id's from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index-list" where 'foo' is the name of the binding. This setting will override the one set in 'spring.cloud.stream.instance-index' |spring.cloud.stream.integration.message-handler-not-propagated-headers | | Message header names that will NOT be copied from the inbound message. -|spring.cloud.stream.metrics.export-properties | | List of properties that are going to be appended to each message. This gets populate by onApplicationEvent, once the context refreshes to avoid overhead of doing per message basis. -|spring.cloud.stream.metrics.key | | The name of the metric being emitted. Should be an unique value per application. Defaults to: ${spring.application.name:${vcap.application.name:${spring.config.name:application}}}. -|spring.cloud.stream.metrics.meter-filter | | Pattern to control the 'meters' one wants to capture. By default all 'meters' will be captured. For example, 'spring.integration.*' will only capture metric information for meters whose name starts with 'spring.integration'. -|spring.cloud.stream.metrics.properties | | Application properties that should be added to the metrics payload For example: `spring.application**`. -|spring.cloud.stream.metrics.schedule-interval | `60s` | Interval expressed as Duration for scheduling metrics snapshots publishing. Defaults to 60 seconds |spring.cloud.stream.output-bindings | | A semi-colon delimited string to explicitly define output bindings (specifically for cases when there is no implicit trigger to create such bindings such as Function, Supplier or Consumer). |spring.cloud.stream.override-cloud-connectors | `false` | This property is only applicable when the cloud profile is active and Spring Cloud Connectors are provided with the application. If the property is false (the default), the binder detects a suitable bound service (for example, a RabbitMQ service bound in Cloud Foundry for the RabbitMQ binder) and uses it for creating connections (usually through Spring Cloud Connectors). When set to true, this property instructs binders to completely ignore the bound services and rely on Spring Boot properties (for example, relying on the spring.rabbitmq.* properties provided in the environment for the RabbitMQ binder). The typical usage of this property is to be nested in a customized environment when connecting to multiple systems. |spring.cloud.stream.pollable-source | `none` | A semi-colon delimited list of binding names of pollable sources. Binding names follow the same naming convention as functions. For example, name '...pollable-source=foobar' will be accessible as 'foobar-iin-0'' binding diff --git a/core/pom.xml b/core/pom.xml index f71140ca4..45331d5f8 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 spring-cloud-stream-core 3.2.3-SNAPSHOT @@ -13,12 +14,11 @@ 3.2.3-SNAPSHOT - - spring-cloud-stream - spring-cloud-stream-binder-test - spring-cloud-stream-test-support - spring-cloud-stream-test-support-internal - spring-cloud-stream-integration-tests - docs + + spring-cloud-stream + spring-cloud-stream-binder-test + spring-cloud-stream-test-support + spring-cloud-stream-test-support-internal + spring-cloud-stream-integration-tests diff --git a/core/docs/.jdk8 b/docs/.jdk8 similarity index 100% rename from core/docs/.jdk8 rename to docs/.jdk8 diff --git a/core/docs/pom.xml b/docs/pom.xml similarity index 100% rename from core/docs/pom.xml rename to docs/pom.xml diff --git a/core/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc similarity index 100% rename from core/docs/src/main/asciidoc/README.adoc rename to docs/src/main/asciidoc/README.adoc diff --git a/core/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc similarity index 81% rename from core/docs/src/main/asciidoc/_configprops.adoc rename to docs/src/main/asciidoc/_configprops.adoc index 55f3103e3..8137bf4d1 100644 --- a/core/docs/src/main/asciidoc/_configprops.adoc +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -14,11 +14,6 @@ |spring.cloud.stream.instance-index | `0` | The instance id of the application: a number from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index" where 'foo' is the name of the binding. |spring.cloud.stream.instance-index-list | | A list of instance id's from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index-list" where 'foo' is the name of the binding. This setting will override the one set in 'spring.cloud.stream.instance-index' |spring.cloud.stream.integration.message-handler-not-propagated-headers | | Message header names that will NOT be copied from the inbound message. -|spring.cloud.stream.metrics.export-properties | | List of properties that are going to be appended to each message. This gets populate by onApplicationEvent, once the context refreshes to avoid overhead of doing per message basis. -|spring.cloud.stream.metrics.key | | The name of the metric being emitted. Should be an unique value per application. Defaults to: ${spring.application.name:${vcap.application.name:${spring.config.name:application}}}. -|spring.cloud.stream.metrics.meter-filter | | Pattern to control the 'meters' one wants to capture. By default all 'meters' will be captured. For example, 'spring.integration.*' will only capture metric information for meters whose name starts with 'spring.integration'. -|spring.cloud.stream.metrics.properties | | Application properties that should be added to the metrics payload For example: `spring.application**`. -|spring.cloud.stream.metrics.schedule-interval | `60s` | Interval expressed as Duration for scheduling metrics snapshots publishing. Defaults to 60 seconds |spring.cloud.stream.output-bindings | | A semi-colon delimited string to explicitly define output bindings (specifically for cases when there is no implicit trigger to create such bindings such as Function, Supplier or Consumer). |spring.cloud.stream.override-cloud-connectors | `false` | This property is only applicable when the cloud profile is active and Spring Cloud Connectors are provided with the application. If the property is false (the default), the binder detects a suitable bound service (for example, a RabbitMQ service bound in Cloud Foundry for the RabbitMQ binder) and uses it for creating connections (usually through Spring Cloud Connectors). When set to true, this property instructs binders to completely ignore the bound services and rely on Spring Boot properties (for example, relying on the spring.rabbitmq.* properties provided in the environment for the RabbitMQ binder). The typical usage of this property is to be nested in a customized environment when connecting to multiple systems. |spring.cloud.stream.pollable-source | `none` | A semi-colon delimited list of binding names of pollable sources. Binding names follow the same naming convention as functions. For example, name '...pollable-source=foobar' will be accessible as 'foobar-iin-0'' binding diff --git a/core/docs/src/main/asciidoc/binders.adoc b/docs/src/main/asciidoc/binders.adoc similarity index 100% rename from core/docs/src/main/asciidoc/binders.adoc rename to docs/src/main/asciidoc/binders.adoc diff --git a/core/docs/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh similarity index 100% rename from core/docs/src/main/asciidoc/ghpages.sh rename to docs/src/main/asciidoc/ghpages.sh diff --git a/core/docs/src/main/asciidoc/images/SCSt-groups.png b/docs/src/main/asciidoc/images/SCSt-groups.png similarity index 100% rename from core/docs/src/main/asciidoc/images/SCSt-groups.png rename to docs/src/main/asciidoc/images/SCSt-groups.png diff --git a/core/docs/src/main/asciidoc/images/SCSt-overview.png b/docs/src/main/asciidoc/images/SCSt-overview.png similarity index 100% rename from core/docs/src/main/asciidoc/images/SCSt-overview.png rename to docs/src/main/asciidoc/images/SCSt-overview.png diff --git a/core/docs/src/main/asciidoc/images/SCSt-partitioning.png b/docs/src/main/asciidoc/images/SCSt-partitioning.png similarity index 100% rename from core/docs/src/main/asciidoc/images/SCSt-partitioning.png rename to docs/src/main/asciidoc/images/SCSt-partitioning.png diff --git a/core/docs/src/main/asciidoc/images/SCSt-sensors.png b/docs/src/main/asciidoc/images/SCSt-sensors.png similarity index 100% rename from core/docs/src/main/asciidoc/images/SCSt-sensors.png rename to docs/src/main/asciidoc/images/SCSt-sensors.png diff --git a/core/docs/src/main/asciidoc/images/SCSt-with-binder.png b/docs/src/main/asciidoc/images/SCSt-with-binder.png similarity index 100% rename from core/docs/src/main/asciidoc/images/SCSt-with-binder.png rename to docs/src/main/asciidoc/images/SCSt-with-binder.png diff --git a/core/docs/src/main/asciidoc/images/custom_vs_global_error_channels.png b/docs/src/main/asciidoc/images/custom_vs_global_error_channels.png similarity index 100% rename from core/docs/src/main/asciidoc/images/custom_vs_global_error_channels.png rename to docs/src/main/asciidoc/images/custom_vs_global_error_channels.png diff --git a/core/docs/src/main/asciidoc/images/producers-consumers.png b/docs/src/main/asciidoc/images/producers-consumers.png similarity index 100% rename from core/docs/src/main/asciidoc/images/producers-consumers.png rename to docs/src/main/asciidoc/images/producers-consumers.png diff --git a/core/docs/src/main/asciidoc/images/redis-binder.png b/docs/src/main/asciidoc/images/redis-binder.png similarity index 100% rename from core/docs/src/main/asciidoc/images/redis-binder.png rename to docs/src/main/asciidoc/images/redis-binder.png diff --git a/core/docs/src/main/asciidoc/images/registration.png b/docs/src/main/asciidoc/images/registration.png similarity index 100% rename from core/docs/src/main/asciidoc/images/registration.png rename to docs/src/main/asciidoc/images/registration.png diff --git a/core/docs/src/main/asciidoc/images/schema_reading.png b/docs/src/main/asciidoc/images/schema_reading.png similarity index 100% rename from core/docs/src/main/asciidoc/images/schema_reading.png rename to docs/src/main/asciidoc/images/schema_reading.png diff --git a/core/docs/src/main/asciidoc/images/schema_resolution.png b/docs/src/main/asciidoc/images/schema_resolution.png similarity index 100% rename from core/docs/src/main/asciidoc/images/schema_resolution.png rename to docs/src/main/asciidoc/images/schema_resolution.png diff --git a/core/docs/src/main/asciidoc/images/spring-initializr.png b/docs/src/main/asciidoc/images/spring-initializr.png similarity index 100% rename from core/docs/src/main/asciidoc/images/spring-initializr.png rename to docs/src/main/asciidoc/images/spring-initializr.png diff --git a/core/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc similarity index 100% rename from core/docs/src/main/asciidoc/index.adoc rename to docs/src/main/asciidoc/index.adoc diff --git a/core/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc similarity index 100% rename from core/docs/src/main/asciidoc/intro.adoc rename to docs/src/main/asciidoc/intro.adoc diff --git a/core/docs/src/main/asciidoc/preface.adoc b/docs/src/main/asciidoc/preface.adoc similarity index 100% rename from core/docs/src/main/asciidoc/preface.adoc rename to docs/src/main/asciidoc/preface.adoc diff --git a/core/docs/src/main/asciidoc/sagan-index.adoc b/docs/src/main/asciidoc/sagan-index.adoc similarity index 100% rename from core/docs/src/main/asciidoc/sagan-index.adoc rename to docs/src/main/asciidoc/sagan-index.adoc diff --git a/core/docs/src/main/asciidoc/spring-cloud-stream.adoc b/docs/src/main/asciidoc/spring-cloud-stream.adoc similarity index 100% rename from core/docs/src/main/asciidoc/spring-cloud-stream.adoc rename to docs/src/main/asciidoc/spring-cloud-stream.adoc diff --git a/core/docs/src/main/ruby/generate_readme.sh b/docs/src/main/ruby/generate_readme.sh similarity index 100% rename from core/docs/src/main/ruby/generate_readme.sh rename to docs/src/main/ruby/generate_readme.sh diff --git a/pom.xml b/pom.xml index 4e79279ca..0e4f6022e 100644 --- a/pom.xml +++ b/pom.xml @@ -35,6 +35,7 @@ core binders bom + docs