chore: use kurrentdb var (#407)

Author: w1am

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,60 +1,97 @@
-name: Bug Report
-description: Create a bug report to help us improve
+name: Bug report
+description: Help us improve the client
+labels:
+  - triage
 body:
-  - type: markdown
-    attributes:
-    value: |
-    Thanks for taking the time to fill out this bug report!
   - type: textarea
-    id: description
+    id: current-behavior
     attributes:
-    label: Bug Description
-    description: A clear and concise description of what the bug is
-    placeholder: Tell us what you see!
+      label: 🐛 Current behavior
+      description: A clear and concise description of what the bug is.
     validations:
-    required: true
-  - type: textarea
-    id: reproduction
-    attributes:
-    label: To Reproduce
-    description: Steps to reproduce the behavior
-    placeholder: |
-      1. Start the KurrentDB server
-      2. Connect the client to the server
-      3. Create a new stream
-      4. Append an event to the stream
-      5. Read the event from the stream
-      6. Observe the issue
-    validations:
-    required: true
+      required: true
   - type: textarea
-    id: expected
+    id: reproduction-steps
     attributes:
-    label: Expected behavior
-    description: A clear and concise description of what you expected to happen
+      label: 🔍 Steps to reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to ...
+        2. Click on ...
+        3. Scroll down to ...
+        4. See error
+
+        You can attach screenshots by dragging and dropping, or selecting and pasting them in the text field.
     validations:
-    required: true
-  - type: markdown
+      required: true
+  - type: input
+    id: reproduction-links
     attributes:
-    value: '## Environment'
+      label: Reproducible link
+      description: A link to a minimal reproducible example. This could be a GitHub repository, CodeSandbox, or any other online code editor.
+      placeholder: e.g, github.com/company/repo
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: 💭 Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
   - type: input
-    id: db
+    id: client-version
     attributes:
-    label: KurrentDB Version
-    placeholder: ex. 24.10.0
+      label: Package version
+      description: What version of the client you're experiencing the issue with.
+      placeholder: e.g., KurrentDB-Client-NodeJS 1.1.2
     validations:
-    required: true
+      required: true
   - type: input
-    id: client
+    id: kurrentdb-version
     attributes:
-    label: Client Version
-    placeholder: ex. 1.0.0
+      label: KurrentDB Version
+      description: What version of the database you are using.
+      placeholder: e.g., KurrentDB v24.10
     validations:
-    required: true
+      required: true
   - type: input
-    id: nodejs-version
+    id: connection
     attributes:
-    label: Node.js Version
-    placeholder: ex. 18.16.0
+      label: Connection string
+      description: What connection string you're using. Hide and sensitive information if necessary.
+      placeholder: e.g., kurrentdb://admin:changeit@localhost:2113
     validations:
-    required: true
+      required: true
+  - type: dropdown
+    id: deployment-environment
+    attributes:
+      label: ☁️ Deployment Environment
+      description: How is KurrentDB deployed?
+      options:
+        - Single-node (Docker)
+        - Single-node (Bare metal/VM)
+        - Multi-node cluster (On-prem)
+        - Multi-node cluster (Cloud)
+        - Managed KurrentDB Cloud
+        - Other (please specify below)
+    validations:
+      required: true
+  - type: input
+    id: deployment-other
+    attributes:
+      label: Other Deployment Details
+      description: If you selected "Other," please specify your deployment setup.
+      placeholder: e.g., Kubernetes with custom networking
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: e.g., macOS 13.1
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/algolia/.github/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Feature request
-    url: https://discuss.kurrent.io/
-    about: Suggest an idea for this project
-  - name: Question / Problem
-    url: https://discuss.kurrent.io/
-    about: Questions and problems with n8n
+  - name: Feature Request
+    url: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/discussions/new?category=ideas&labels=triage&title=Feature%20request%3A%20
+    about: Request a feature to add to the client
+  - name: Ask a Question
+    url: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/discussions/new?category=q-a&labels=triage
+    about: Ask questions and discuss with other community members.

.github/workflows/test_dispatch.yml renamed to .github/workflows/qa.yml

@@ -1,16 +1,17 @@
-name: "Dispatch"
+name: QA
 
 on:
   workflow_dispatch:
     inputs:
-      version:
-        description: "Version tag"
+      image:
+        description: 'Full image name'
         required: true
+        default: 'docker.kurrent.io/kurrent-staging/kurrentdb:ci'
         type: string
 
 jobs:
   test:
     name: Test
     uses: ./.github/workflows/tests.yml
     with:
-      version: ${{ inputs.version }}
+      image: ${{ inputs.image }}

.github/workflows/test_LTS.yml

@@ -6,11 +6,12 @@ on:
     branches:
       - master
   schedule:
-    - cron: "0 3 * * 0" # Every sunday at 3am UTC.
+    - cron: '0 0 * * 0'  # Run every Sunday at midnight UTC
 
 jobs:
   test:
     name: Test
     uses: ./.github/workflows/tests.yml
     with:
-      version: "latest"
+      image: ${{ fromJSON(vars.KURRENTDB_DOCKER_IMAGES).lts.fullname }}
+    secrets: inherit

.github/workflows/test_ee.yml

@@ -6,7 +6,7 @@ on:
     branches:
       - master
   schedule:
-    - cron: "0 3 * * *" # Every day at 3am UTC.
+    - cron: '0 0 * * 0'  # Run every Sunday at midnight UTC
 
 jobs:
   tests:
@@ -54,4 +54,4 @@ jobs:
       - name: Run Tests
         run: yarn test ${{ matrix.group.path }} --ci --run-in-band --forceExit
         env:
-          KURRENT_IMAGE: eventstore-ee:${{ env.KURRENT_VERSION }}
+          KURRENT_IMAGE: "docker.eventstore.com/eventstore-ee/eventstoredb-commercial:${{ env.KURRENT_VERSION }}"

.github/workflows/test_next.yml

@@ -6,11 +6,12 @@ on:
     branches:
       - master
   schedule:
-    - cron: "0 3 * * *" # Every day at 3am UTC.
+    - cron: '0 0 * * 0'  # Run every Sunday at midnight UTC
 
 jobs:
   test:
     name: Test
     uses: ./.github/workflows/tests.yml
     with:
-      version: "ci"
+      image: ${{ fromJSON(vars.KURRENTDB_DOCKER_IMAGES).ci.fullname }}
+    secrets: inherit

.github/workflows/test_previous_LTS.yml

@@ -6,11 +6,12 @@ on:
     branches:
       - master
   schedule:
-    - cron: "0 3 * * 0" # Every sunday at 3am UTC.
+    - cron: '0 0 * * 0'  # Run every Sunday at midnight UTC
 
 jobs:
   test:
     name: Test
     uses: ./.github/workflows/tests.yml
     with:
-      version: "previous-lts"
+      image: ${{ fromJSON(vars.KURRENTDB_DOCKER_IMAGES)['previous-lts'].fullname }}
+    secrets: inherit

.github/workflows/tests.yml

@@ -3,7 +3,7 @@ name: tests workflow
 on:
   workflow_call:
     inputs:
-      version:
+      image:
         required: true
         type: string
 
@@ -38,6 +38,13 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Login to Cloudsmith
+        uses: docker/login-action@v3
+        with:
+          registry: docker.kurrent.io
+          username: ${{ secrets.CLOUDSMITH_CICD_USER }}
+          password: ${{ secrets.CLOUDSMITH_CICD_TOKEN }}
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: .github/files/.nvmrc
@@ -57,4 +64,4 @@ jobs:
       - name: Run Tests
         run: yarn test ${{ matrix.group.path }} --ci --run-in-band --forceExit
         env:
-          KURRENT_IMAGE: eventstore-ce:${{ inputs.version }}
+          KURRENT_IMAGE: ${{ inputs.image }}

CONTRIBUTING.md

@@ -5,7 +5,7 @@ Development is done on the `master` branch. We attempt to do our best to ensure
 ## Initial Setup
 
 **Prerequisites:**
-- Node.js (version 14 or higher, although version 12.18.3 is also supported)
+- Node.js (version 20 or higher)
 
 **Repository Setup:**
 1. Clone the repository:

README.md

@@ -8,14 +8,18 @@
 
 # KurrentDB NodeJS Client
 
-[![license][license-badge]][license-badge-url]
 [![Previous LTS](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_previous_LTS.yml/badge.svg)](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_previous_LTS.yml)
 [![LTS](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_LTS.yml/badge.svg)](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_LTS.yml)
 [![next](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_next.yml/badge.svg)](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_next.yml)
 
-KurrentDB is the event-native database, where business events are immutably
-stored and streamed. Designed for event-sourced, event-driven, and microservices
-architectures.
+KurrentDB is a database that's engineered for modern software applications and event-driven architectures. Its
+event-native design simplifies data modeling and preserves data integrity while the integrated streaming engine solves
+distributed messaging challenges and ensures data consistency.
+
+### Documentation
+
+* [API Reference](https://pkg.go.dev/github.com/kurrent.io/KurrentDB-Client-Go?tab=doc)
+* [Samples](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/tree/master/samples)
 
 ## Packages
 
@@ -30,24 +34,32 @@ This monorepo contains the following packages:
 The client uses [KurrentDB-Bridge-Client](https://github.com/kurrent-io/EventStore-Client-NodeJS)
 to significantly improve read performance by leveraging Rust through native addons.
 
-## Support
-
-Information on support can be found on our website: [Kurrent Support]
-
 ## Communities
 
-- [Discuss]
-- [Discord (Kurrent)][discord-kurrent]
-- [Discord (ddd-cqrs-es)][discord-ddd-cqrs-es]
+[Join our global community](https://www.kurrent.io/community) of developers.
+
+- [Discuss](https://discuss.kurrent.io/)
+- [Discord (Kurrent)](https://discord.gg/Phn9pmCw3t)
+- [Discord (ddd-cqrs-es)](https://discord.com/invite/sEZGSHNNbH)
 
 ## Contributing
 
-Refer to our [Contribution Guidelines]
+Development is done on the `master` branch.
+We attempt to do our best to ensure that the history remains clean and to do so, we generally ask contributors to squash
+their commits into a set or single logical commit.
+
+- [Create an issue](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/issues)
+- [Documentation](https://docs.kurrent.io/)
+- [Contributing guide](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/CONTRIBUTING.md)
+
+## Building the client
+
+The client is built using the [NodeJS](https://nodejs.org/) JavaScript runtime. To build the client, you need to have Node
+installed on your machine. You can download it from the official NodeJS website.
+Once you have it installed, you can build the client by running the following command in the root directory of the
+project:
 
-[Kurrent support]: https://kurrent.io/support/
-[discuss]: https://discuss.kurrent.io/
-[discord-kurrent]: https://discord.gg/Phn9pmCw3t
-[discord-ddd-cqrs-es]: https://discord.com/invite/sEZGSHNNbH
-[license-badge]: https://img.shields.io/npm/l/@kurrent/kurrentdb-client.svg
-[license-badge-url]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/LICENSE
-[contribution guidelines]: https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/CONTRIBUTING.md
+```bash
+yarn install
+yarn build
+```