From c0dc3d3de5dcc0576f938da7aafb2b75e8d0b948 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Wed, 19 Feb 2025 13:11:38 -0600 Subject: [PATCH] Update 1.0.x readme w/ locked warning --- README.adoc | 102 ++-------------------------------------------------- 1 file changed, 2 insertions(+), 100 deletions(-) diff --git a/README.adoc b/README.adoc index 55e4892a..759d1368 100644 --- a/README.adoc +++ b/README.adoc @@ -2,104 +2,6 @@ :docs: https://docs.spring.io/spring-pulsar/reference :github: https://github.com/spring-projects/spring-pulsar -Spring for Apache Pulsar provides a basic Spring-friendly API for developing https://pulsar.apache.org/[Apache Pulsar] applications. +WARNING: The 1.0.x branch is out of OSS support -**#TIP#**: Most of the ideas in this project are borrowed from the Spring for Apache Kafka project, thus a familiarity with it would help. - -include::spring-pulsar-docs/src/main/antora/modules/ROOT/pages/intro/project-state.adoc[leveloffset=+1] - -== Getting Started -The {docs}[reference documentation] includes a {docs}/reference/pulsar.html#quick-tour[quick tour] section. - -== Getting Help -Are you having trouble with Spring for Apache Pulsar? We want to help! - -* Check the {docs}[reference documentation] -* Learn the Spring basics -- Spring for Apache Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation. -If you are new to Spring, try one of the https://spring.io/guides[guides]. -// TODO (NYI): * If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features. -* Ask a question -- we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`]. -* Report bugs with Spring for Apache Pulsar at {github}/issues[github.com/spring-projects/spring-pulsar/issues]. - - - -== Reporting Issues -Spring for Apache Pulsar uses GitHub's integrated issue tracking system to record bugs and feature requests. -If you want to raise an issue, please follow the recommendations below: - -* Before you log a bug, please search the {github}/issues[issue tracker] to see if someone has already reported the problem. -* If the issue doesn't already exist, {github}/issues/new[create a new issue]. -* Please provide as much information as possible with the issue report. -We like to know the Spring for Apache Pulsar version, operating system, and JVM version you're using. -* If you need to paste code or include a stack trace, use Markdown +++```+++ escapes before and after your text. -* If possible, try to create a test case or project that replicates the problem and attach it to the issue. - - - -== Building from Source -You don't need to build from source to use Spring for Apache Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring for Apache Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper]. -You also need JDK 17. - -[source,shell] ----- -./gradlew publishToMavenLocal ----- - -This will build all jars and documentation and publish them to your local Maven cache. -It won't run any of the tests. -If you want to build everything and run tests, use the `build` task: - -[source,shell] ----- -./gradlew build ----- - -NOTE: Some tests rely on a Docker daemon to test against live services using https://www.testcontainers.org/[Testcontainers]. -These tests will be skipped if a local Docker daemon is not available. - -The above command will build everything and run all unit tests and integration tests except the `PulsarFunctionAdministrationIntegrationTests` which requires the _Pulsar RabbitMQ Connector_ to be downloaded prior to running. -To download the connector (one time only) and run the integration test, add a system property to the task as follows: - -[source,shell] ----- -./gradlew build -DdownloadRabbitConnector=true ----- - -By default, the `build` command will run unit tests followed by integration tests. -If you want skip tests, use the `-x test` and/or `-x integrationTest` options: - -[source,shell] ----- -./gradlew build -x test -x integrationTest ----- - -== Modules -There are several modules in Spring for Apache Pulsar. Here is a quick overview: - -=== spring-pulsar -The main library that provides the API to access Apache Pulsar. - -=== spring-pulsar-bom -Provides a Maven BOM (https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms[Bill of Materials]) that recommends a consistent version for all Spring for Apache Pulsar published modules. - -=== spring-pulsar-cache-provider -Provides the interfaces for the cache provider used by the main library to cache producers. - -=== spring-pulsar-cache-provider-caffeine -Provides the implementation of the cache provider using a shaded version of Caffeine. - -=== spring-pulsar-dependencies -Provides a Gradle https://docs.gradle.org/current/userguide/java_platform_plugin.html[java-platform] that recommends dependency versions. - -=== spring-pulsar-docs -Provides reference docs and handles aggregating javadocs. - -=== spring-pulsar-reactive -Provides the API to access Apache Pulsar using a Reactive client. - -=== spring-pulsar-sample-apps -Provides sample applications to illustrate Spring for Apache Pulsar functionality as well as provide ability for quick manual verification during development. - - -== License -Spring for Apache Pulsar is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license]. +== This branch is locked - please file any issues in the https://github.com/spring-projects/spring-pulsar-commercial/tree/1.0.x[spring-pulsar-commercial] repo