From 34bb6342bb6a3d3b8ba5e73b63bf68a9631749a7 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Fri, 1 Dec 2023 23:15:08 -0800 Subject: [PATCH 1/5] Update README.md --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 12cd97c6b..cc094bd87 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,42 @@ # NServiceBus.RavenDB -The official [NServiceBus](https://github.com/Particular/NServiceBus) persistence implementation for [RavenDB.](https://ravendb.net/) +NServiceBus.RavenDB is the official NServiceBus persistence implementation for [RavenDB](https://ravendb.net/). -Learn more about NServiceBus.RavenDB through our [documentation.](http://docs.particular.net/nservicebus/ravendb/) +It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems. -If you are interested in contributing, please follow the instructions [here.](https://github.com/Particular/NServiceBus/blob/develop/CONTRIBUTING.md) +## Official documentation -## Running the tests +See the [RavenDB Persistence documentation](http://docs.particular.net/nservicebus/ravendb/) for more details on how to use it. -Running the tests requires RavenDB 5.2 and two environment variables. One named `CommaSeparatedRavenClusterUrls` containing the URLs, separated by commas, to connect to a RavenDB cluster to run cluster-wide transaction tests. The second one named `RavenSingleNodeUrl` containing the URL of a single node RavenDB instance to run non-cluster-wide tests. The tests can be run with RavenDB servers hosted on a Docker container. +## Running tests locally + +Running the tests requires RavenDB 5.2 and two environment variables: + +1. `CommaSeparatedRavenClusterUrls` containing the URLs, separated by commas, to connect to a RavenDB cluster to run cluster-wide transaction tests +1. `RavenSingleNodeUrl` containing the URL of a single node RavenDB instance to run non-cluster-wide tests + +The tests can be run with RavenDB servers hosted on a Docker container. ## CI Workflow The [CI workflow](/.github/workflows/ci.yml) requires two secrets unique to RavenDB to be defined both as Actions and Dependabot secrets: -* RAVENDB_LICENSE: A RavenDB development license, expressed as JSON, but all on one line, with escaped quotes `\"` -* PASSPHRASE: Any phrase used to encrypt the connection information between steps in the CI +1. RAVENDB_LICENSE: A RavenDB development license, expressed as JSON, but all on one line, with escaped quotes `\"` +1. PASSPHRASE: Any phrase used to encrypt the connection information between steps in the CI The values used by Particular are both stored in a secure note called "RavenDB CI Secrets". ### Spinning up the necessary infrastructure -This assumes docker and docker-compose are properly setup. It works currently on Windows with Docker Desktop but not on docker hosted in WSL2 only. +This assumes docker and docker-compose are properly setup. It currently works on Windows with Docker Desktop but not on docker hosted in WSL2 only. 1. [Acquire a developer license](https://ravendb.net/license/request/dev) 1. Convert the multi-line license JSON to a single line JSON and set the `LICENSE` variable. Alternatively the license can be set using [an `.env` file](https://docs.docker.com/compose/environment-variables/). 1. Inside the root directory of the repository issue the following command: `docker-compose up -d`. The single node server is reachable under [`http://localhost:8080`](http://localhost:8080). The cluster leader is reachable under [`http://localhost:8081`](http://localhost:8081). + +## Contributing + +If you are interested in contributing, please follow the instructions on [How to contribute](https://docs.particular.net/platform/contributing). + From 29e22cb8a9356394771b6e1a7f7b53a70e78b8b3 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Wed, 6 Dec 2023 22:18:59 -0800 Subject: [PATCH 2/5] Update README.md --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index cc094bd87..504006f84 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ NServiceBus.RavenDB is the official NServiceBus persistence implementation for [ It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems. -## Official documentation +## Documentation See the [RavenDB Persistence documentation](http://docs.particular.net/nservicebus/ravendb/) for more details on how to use it. @@ -35,8 +35,3 @@ This assumes docker and docker-compose are properly setup. It currently works on 1. Inside the root directory of the repository issue the following command: `docker-compose up -d`. The single node server is reachable under [`http://localhost:8080`](http://localhost:8080). The cluster leader is reachable under [`http://localhost:8081`](http://localhost:8081). - -## Contributing - -If you are interested in contributing, please follow the instructions on [How to contribute](https://docs.particular.net/platform/contributing). - From 9f99519017caf7169d328af946db3e384e7f4f5f Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Fri, 15 Dec 2023 13:26:40 -0800 Subject: [PATCH 3/5] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 504006f84..037ceca0d 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ NServiceBus.RavenDB is the official NServiceBus persistence implementation for [ It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems. -## Documentation - See the [RavenDB Persistence documentation](http://docs.particular.net/nservicebus/ravendb/) for more details on how to use it. ## Running tests locally From e4a3cc14b35f970a7c9abeed2e480680cd411fe2 Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Fri, 15 Dec 2023 15:51:19 -0800 Subject: [PATCH 4/5] Update README.md Co-authored-by: Jayanthi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 037ceca0d..b6da16561 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NServiceBus.RavenDB -NServiceBus.RavenDB is the official NServiceBus persistence implementation for [RavenDB](https://ravendb.net/). +NServiceBus.RavenDB is the official [NServiceBus](https://github.com/Particular/NServiceBus) persistence implementation for [RavenDB](https://ravendb.net/). It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems. From 50163672c6a3e474dedac3f47d2fc279594c9dee Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Sat, 16 Dec 2023 19:10:23 -0800 Subject: [PATCH 5/5] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6da16561..ac304b8c7 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,11 @@ The tests can be run with RavenDB servers hosted on a Docker container. ## CI Workflow -The [CI workflow](/.github/workflows/ci.yml) requires two secrets unique to RavenDB to be defined both as Actions and Dependabot secrets: +The [CI workflow](/.github/workflows/ci.yml) requires the following secret, unique to RavenDB, to be defined both as an Actions and Dependabot secret: 1. RAVENDB_LICENSE: A RavenDB development license, expressed as JSON, but all on one line, with escaped quotes `\"` -1. PASSPHRASE: Any phrase used to encrypt the connection information between steps in the CI -The values used by Particular are both stored in a secure note called "RavenDB CI Secrets". +The value used by Particular is stored in a secure note called "RavenDB CI Secrets". ### Spinning up the necessary infrastructure