Skip to content

Commit

Permalink
Bump version & generate release notes (#654)
Browse files Browse the repository at this point in the history
## Usage and product changes
We update VERSION to 2.28.2-rc0 and create release notes.
  • Loading branch information
typedb-bot authored May 17, 2024
2 parents 0f17b00 + ee66f61 commit 355acac
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 23 deletions.
43 changes: 21 additions & 22 deletions RELEASE_NOTES_LATEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Documentation: https://typedb.com/docs/drivers/rust/overview


```sh
cargo add [email protected].1
cargo add [email protected].2-rc0
```


Expand All @@ -29,7 +29,7 @@ Documentation: https://typedb.com/docs/drivers/java/overview
<dependency>
<groupid>com.vaticle.typedb</groupid>
<artifactid>typedb-driver</artifactid>
<version>2.28.1</version>
<version>2.28.2-rc0</version>
</dependency>
</dependencies>
```
Expand All @@ -42,7 +42,7 @@ Documentation: https://typedb.com/docs/drivers/python/overview
Available through https://pypi.org

```
pip install typedb-driver==2.28.1
pip install typedb-driver==2.28.2-rc0
```

### NodeJS driver
Expand All @@ -51,7 +51,7 @@ NPM package: https://www.npmjs.com/package/typedb-driver
Documentation: https://typedb.com/docs/drivers/nodejs/overview

```
npm install [email protected].1
npm install [email protected].2-rc0
```

### C# driver
Expand All @@ -61,38 +61,37 @@ Documentation: https://typedb.com/docs/drivers/csharp/overview

```xml
<ItemGroup>
<PackageReference Include="TypeDB.Driver" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-x64" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-x64" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver.Pinvoke.win-x64" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-arm64" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-arm64" Version="2.28.1" />
<PackageReference Include="TypeDB.Driver" Version="2.28.2-rc0" />
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-x64" Version="2.28.2-rc0" />
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-x64" Version="2.28.2-rc0" />
<PackageReference Include="TypeDB.Driver.Pinvoke.win-x64" Version="2.28.2-rc0" />
<PackageReference Include="TypeDB.Driver.Pinvoke.osx-arm64" Version="2.28.2-rc0" />
<PackageReference Include="TypeDB.Driver.Pinvoke.linux-arm64" Version="2.28.2-rc0" />
</ItemGroup>
```

### C++ driver

Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-cpp+version:2.28.1
Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-cpp+version:2.28.2-rc0
Documentation: https://typedb.com/docs/drivers/cpp/overview

### C driver

Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-clib+version:2.28.1
Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-clib+version:2.28.2-rc0


## New Features
- **Copy jni library from input stream rather than file**
We now copy the jni library by reading from it as an input stream rather than as a file copy. This approach works when the JNI jars are nested, such as in Spring Boot projects.


## Bugs Fixed
- **JNI library loading uses a predetermined file name**
The unpacked JNI library now uses a pre-determined filename. This replaces logic to extract the filename from the packaged resource.



## Code Refactors
- **Fix misleading cloud encryption error message**
The old version of the cloud encryption error message confused the user in case, for example, their endpoint is not encrypted, but the connection is. There are also other potential causes of the `received corrupt message` status message, that we can't understand on a deeper level, so it's more correct to have a less specific error message here.



## Other Improvements
- **Each API reference is combined in a single partial for easier preview and usage**

For each driver, we move all AsciiDoc `include` directives to a dedicated partial called `api-reference.adoc` in the drivers repo.
This way, all the content can be previewed from the typedb-driver repo and included in the docs web content with a single include directive.



2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.28.1
2.28.2-rc0

0 comments on commit 355acac

Please sign in to comment.