Merge remote-tracking branch 'origin/develop' into fix/project-structure

🔒 Scanned for secrets using gitleaks 8.28.0

Author: 1abhishekpandey

.circleci/config.yml

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "BUG : <Title>"
+labels: bug, open source
+assignees: itsdebs
+---
+
+**Describe the bug**
+Please provide the following information:
+
+1. A clear and concise description of what the bug is
+2. Share the event payload
+3. Offer a minimal viable example to reproduce the issue
+4. Include the error's stack trace
+5. Mention the date when the issue began
+
+**To Reproduce**
+Steps to reproduce the behaviour:
+
+1. Initialise Java SDK
+2. Make events '....'
+3. See the error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Version of the _Java_ SDK**
+Please mention the version of the Rudderstack Java SDK you are using (e.g., Java SDK v1.0.0).
+
+**SDK initialisation snippet**
+Share the code snippet used for initializing the Java SDK.
+
+**Check for Correct Usage of _writeKey_ and _dataPlaneUrl_**
+Confirm that the correct `writeKey` and `dataPlaneUrl` are utilized during SDK initialization.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -14,11 +14,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
-          distribution: 'temurin'
+          java-version: 17
+          distribution: 'zulu' # Alternative distribution options are available.
 
       - name: Set up Maven
         uses: stCarolas/setup-maven@v4.5
@@ -34,7 +34,7 @@ jobs:
             ${{ runner.os }}-maven-
 
       - name: Cache SonarCloud packages
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
@@ -91,6 +91,6 @@ jobs:
 
       - name: Sonar analysis
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: mvn sonar:sonar
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=rudderlabs_rudder-sdk-java

.github/workflows/build-and-quality-checks.yml

@@ -1,3 +1,10 @@
+# Version 3.1.2 (August 1, 2024)
+- [New](https://github.com/rudderlabs/rudder-sdk-java/pull/113) Release all Java modules with version 3.1.2
+
+# Version 3.1.0 (December 14, 2023)
+- [New](https://github.com/rudderlabs/rudder-sdk-java/pull/86) Update Java to the latest version
+- [New](https://github.com/rudderlabs/rudder-sdk-java/pull/83) Improve links in Rudderstack documentation
+
 # Version 3.0.0 (January 9, 2023)
 - [New](https://github.com/rudderlabs/rudder-sdk-java/pull/43) Add CI feature
 - [New](https://github.com/rudderlabs/rudder-sdk-java/pull/41) Add support for channel object in individual payload
@@ -45,7 +52,7 @@
 
 - [Fix](https://github.com/rudderlabs/rudder-sdk-java/pull/223) cli wasnt setting event fields
 - [Fix](https://github.com/rudderlabs/rudder-sdk-java/pull/222) e2e fix - traits was defined twice in command line opts
-- [Fix](https://github.com/rudderlabs/rudder-sdk-java/pull/221) Require either userId or anonymousId \(aligns with other Rudder SDK conventions\)
+- [Fix](https://github.com/rudderlabs/rudder-sdk-java/pull/221) Require either userId or anonymousId \(aligns with other Rudderstack SDK conventions\)
 
 - [Fix](https://github.com/rudderlabs/rudder-sdk-java/pull/117): This fix gracefully retries temporary HTTP errors such as 5xx server errors. Previously such HTTP errors were not being retried.
 

.github/workflows/notion-pr-sync.yml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Rudder, Inc.
+Copyright (c) 2014 Rudderstack, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

CHANGELOG.md

@@ -1,57 +1,64 @@
 [![Build & Code Quality Checks](https://github.com/rudderlabs/rudder-sdk-java/actions/workflows/build-and-quality-checks.yml/badge.svg?branch=ci%2FaddCIFeatures)](https://github.com/rudderlabs/rudder-sdk-java/actions/workflows/build-and-quality-checks.yml)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/rudderlabs/rudder-sdk-java)
 
 # What is RudderStack?
 
-[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse.
+[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from
+your websites, apps, cloud tools, and data warehouse.
 
 ## RudderStack's Java SDK
 
-RudderStack’s Java SDK allows you to track your customer event data from your Java code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.
+RudderStack’s Java SDK allows you to track your customer event data from your Java code. Once enabled, the event requests hit
+the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.
 
-For detailed documentation on the Java SDK, click [here](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/).
+For detailed documentation on the Java SDK,
+click [here](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/).
 
 ## Getting Started with the RudderStack Java SDK
 
 *Add to `pom.xml`:*
 
 ```xml
+
 <dependency>
     <groupId>com.rudderstack.sdk.java.analytics</groupId>
     <artifactId>analytics</artifactId>
-    <version>3.0.0</version>
+    <version>x.y.z</version>
 </dependency>
 
 ```
 
 *or if you're using Gradle:*
 
 ```bash
-implementation 'com.rudderstack.sdk.java.analytics:analytics:3.0.0'
+implementation 'com.rudderstack.sdk.java.analytics:analytics:x.y.z'
 ```
 
 ## Initializing ```RudderClient```
 
 ```java 
-RudderAnalytics analytics = RudderAnalytics
-         .builder("<WRITE_KEY>")
-         .setDataPlaneUrl("<DATA_PLANE_URL>")
-         .build();
+RudderAnalytics analytics=RudderAnalytics
+        .builder("<WRITE_KEY>")
+        .setDataPlaneUrl("<DATA_PLANE_URL>")
+        .build();
 ```
 
 ## Sending events
 
 ```java
-Map<String, Object> map = new HashMap<>();
-map.put("name", "John Marshal");
-map.put("email", "john@example.com");
-analytics.enqueue(IdentifyMessage.builder()
+Map<String, Object> map=new HashMap<>();
+        map.put("name","John Marshal");
+        map.put("email","john@example.com");
+        analytics.enqueue(IdentifyMessage.builder()
         .userId("6754ds7d9")
         .traits(map)
-);
+        );
 ```
 
-For more information on the different types of events supported by the Java SDK, refer to our [docs](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/).
+For more information on the different types of events supported by the Java SDK, refer to
+our [docs](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/).
 
 ## Contact Us
 
-If you come across any issues while configuring or using this SDK, feel free to start a conversation on our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you.
+If you come across any issues while configuring or using this SDK, feel free to start a conversation on
+our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you.