Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/express version #197

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/express version #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c04e19
fix: corrected documentation to use the appropriate latest version
Oct 1, 2024
12b7716
fix: Update node sdk documetations requirements when used in conjunct…
Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/content/docs/developer-tools/sdks/backend/java-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Kinde’s SDK is available through [Maven](https://search.maven.org/). To insta
<dependency>
<groupId>com.kinde</groupId>
<artifactId>java-sdk</artifactId>
<version>2.0.0</version>
<version>[2.0.1,)</version>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider using a more restrictive version range

The current version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. This could lead to unexpected breaking changes in the future. Consider using a more restrictive range to ensure compatibility, such as [2.0.1,3.0.0) which would allow all 2.x versions but exclude 3.0.0 and above.

-  <version>[2.0.1,)</version>
+  <version>[2.0.1,3.0.0)</version>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<version>[2.0.1,)</version>
<version>[2.0.1,3.0.0)</version>

</dependency>
```

Expand All @@ -74,7 +74,7 @@ repositories {
}

dependencies {
implementation "com.kinde:java-sdk:2.0.0”
implementation "com.kinde:java-sdk:+”
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid using the latest version syntax (+) in production

Using + for the version in Gradle dependencies can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.

Consider using a specific version or a range with an upper bound:

-     implementation "com.kinde:java-sdk:+"
+     implementation "com.kinde:java-sdk:2.0.1"

Or if you want to allow patch updates:

-     implementation "com.kinde:java-sdk:+"
+     implementation "com.kinde:java-sdk:2.0.+"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
implementation "com.kinde:java-sdk:+”
implementation "com.kinde:java-sdk:2.0.1"

}
```

Expand Down Expand Up @@ -533,7 +533,7 @@ In order to use this SDK include following POM dependency.
<dependency>
<groupId>com.kinde</groupId>
<artifactId>kinde-j2ee</artifactId>
<version>2.0.0</version>
<version>[2.0.1,)</version>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider using a more restrictive version range for kinde-j2ee

Similar to the previous Maven dependency, the version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. To ensure compatibility and avoid unexpected breaking changes, consider using a more restrictive range.

-      <version>[2.0.1,)</version>
+      <version>[2.0.1,3.0.0)</version>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<version>[2.0.1,)</version>
<version>[2.0.1,3.0.0)</version>

</dependency>
```

Expand All @@ -542,7 +542,7 @@ In order to use this SDK include following POM dependency.
In order to use the SDK with a Gradle build process please use the following dependency.

```groovy
configuration('com.kinde:kinde-j2ee:2.0.0')
configuration('com.kinde:kinde-j2ee:+')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid using the latest version syntax (+) for kinde-j2ee in production

As with the previous Gradle dependency, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.

Consider using a specific version or a range with an upper bound:

-    configuration('com.kinde:kinde-j2ee:+')
+    configuration('com.kinde:kinde-j2ee:2.0.1')

Or if you want to allow patch updates:

-    configuration('com.kinde:kinde-j2ee:+')
+    configuration('com.kinde:kinde-j2ee:2.0.+')
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
configuration('com.kinde:kinde-j2ee:+')
configuration('com.kinde:kinde-j2ee:2.0.1')

```

### Project configuration
Expand Down Expand Up @@ -638,15 +638,15 @@ To use configure Spring Boot to use Kinde for authentication, include the follow
<dependency>
<groupId>com.kinde.spring</groupId>
<artifactId>kinde-springboot-starter</artifactId>
<version>2.0.0</version>
<version>[2.0.1,)</version>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider using a more restrictive version range for kinde-springboot-starter

Consistent with the previous Maven dependencies, the version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. To ensure compatibility and avoid unexpected breaking changes, consider using a more restrictive range.

-      <version>[2.0.1,)</version>
+      <version>[2.0.1,3.0.0)</version>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<version>[2.0.1,)</version>
<version>[2.0.1,3.0.0)</version>

</dependency>
```
#### Gradle

To use the SDK with a Gradle build process, use the following dependency.

```groovy
configuration('com.kinde.spring:kinde-springboot-starter:2.0.0')
configuration('com.kinde.spring:kinde-springboot-starter:+')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid using the latest version syntax (+) for kinde-springboot-starter in production

Consistent with the previous Gradle dependencies, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.

Consider using a specific version or a range with an upper bound:

-    configuration('com.kinde.spring:kinde-springboot-starter:+')
+    configuration('com.kinde.spring:kinde-springboot-starter:2.0.1')

Or if you want to allow patch updates:

-    configuration('com.kinde.spring:kinde-springboot-starter:+')
+    configuration('com.kinde.spring:kinde-springboot-starter:2.0.+')
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
configuration('com.kinde.spring:kinde-springboot-starter:+')
configuration('com.kinde.spring:kinde-springboot-starter:2.0.1')

```

### Usage
Expand Down Expand Up @@ -704,7 +704,7 @@ To use this SDK, include the following dependency in your `pom.xml`:
<dependency>
<groupId>com.kinde</groupId>
<artifactId>kinde-management</artifactId>
<version>2.0.0</version>
<version>[2.0.1,).0</version>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Fix version range syntax and consider using a more restrictive range

There's a typo in the version range syntax. The .0 at the end should be removed. Additionally, as with previous Maven dependencies, consider using a more restrictive range to avoid potential breaking changes.

-   <version>[2.0.1,).0</version>
+   <version>[2.0.1,3.0.0)</version>

This change removes the typo and restricts the range to versions 2.0.1 up to, but not including, 3.0.0.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<version>[2.0.1,).0</version>
<version>[2.0.1,3.0.0)</version>

</dependency>
```

Expand All @@ -713,7 +713,7 @@ To use this SDK, include the following dependency in your `pom.xml`:
For Gradle, add the following dependency to your build file:

```groovy
implementation('com.kinde:kinde-management:2.0.0')
implementation('com.kinde:kinde-management:+')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid using the latest version syntax (+) for kinde-management in production

Consistent with the previous Gradle dependencies, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.

Consider using a specific version or a range with an upper bound:

-implementation('com.kinde:kinde-management:+')
+implementation('com.kinde:kinde-management:2.0.1')

Or if you want to allow patch updates:

-implementation('com.kinde:kinde-management:+')
+implementation('com.kinde:kinde-management:2.0.+')
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
implementation('com.kinde:kinde-management:+')
implementation('com.kinde:kinde-management:2.0.1')

```

### Building the SDK from Source
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/developer-tools/sdks/backend/nodejs-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can view the [NodeJS docs](https://github.com/kinde-oss/kinde-nodejs-sdk) a

## Requirements

- Node version 18.x.x or newer.
- Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/kinde-oss/kinde-node-express), then Node 20.x.x or new is required.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brettchaldecott - shouldnt there be changes to the Express SDK doc, not the NodeJS SDK doc?

- If you haven’t got a Kinde account, [register for free here](https://app.kinde.com/register) (no credit card required). Registering gives you a Kinde domain, which you need to get started, e.g. `yourapp.kinde.com`.

## Install
Expand Down