Skip to content

Commit

Permalink
chore(docs): Update release notes (#1217)
Browse files Browse the repository at this point in the history 
Preview:
https://deploy-preview-129--electric-sql-website.netlify.app/docs/reference/release_notes#2024-05-02---v0102

---------

Co-authored-by: Sam Willis <[email protected]>
  • Loading branch information
@alco @samwillis
alco and samwillis committed May 14, 2024
1 parent 0747540 commit 99dfabd
Showing 1 changed file with 50 additions and 25 deletions.
75 changes: 50 additions & 25 deletions docs/reference/release_notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,33 @@ To learn more about the major feature releases of Electric, see release announce

To see the complete change log for each new release, see the [Releases page](https://github.com/electric-sql/electric/releases) on GitHub or the `CHANGELOG.md` file of each individual component:

- Sync service: [/components/electric/CHANGELOG.md](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md)
- TypeScript client: [/clients/typescript/CHANGELOG.md](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md)
- create-electric-app: [/examples/starter/CHANGELOG.md](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md)
- @electric-sql/prisma-generator: [/generator/CHANGELOG.md](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md)
- [Sync service](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md)
- [TypeScript client](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md)
- [create-electric-app](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md)
- [@electric-sql/prisma-generator](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md)


## 2024-10-14 - v0.10
## 2024-05-02 - v0.11

[Announcement post](/blog/2024/05/14/electricsql-postgres-client-support).

This release introduces a new database driver for PGLite, enabling client applications to use a local Postgres database. It also the first release to maintain replication stream continuity in the face of the sync service's restarts.

#### Updated components

Component | Version
--------- | -------
[Sync service][1] | [0.11.1](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#0111)
[TypeScript client][2] | [0.11.2](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#0112)
[create-electric-app][3] | [0.3.1](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#031)

#### Compatibility notes

**Sync service**

- Electric no longer tries decode the JWT signing key by default. A new configuration option `AUTH_JWT_KEY_IS_BASE64_ENCODED` has been added to let the developer choose whether Electric should use the configured signing key as is or base64-decode it first.

## 2024-04-10 - v0.10

[Announcement post](/blog/2024/04/10/electricsql-v0.10-released).

Expand All @@ -30,9 +50,9 @@ The first release to support where-clause and include-tree filtering with Shape-

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.10.0](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#0100)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.10.0](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#0100)
[@electric-sql/prisma-generator](https://www.npmjs.com/package/@electric-sql/prisma-generator) | [1.1.4](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#114)
[Sync service][1] | [0.10.0](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#0100)
[TypeScript client][2] | [0.10.0](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#0100)
[@electric-sql/prisma-generator][4] | [1.1.4](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#114)

#### Compatibility notes

Expand All @@ -44,8 +64,8 @@ This release does not introduce any noteable breaking changes.

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.9.4](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#094)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.9.5](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#095)
[Sync service][1] | [0.9.4](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#094)
[TypeScript client][2] | [0.9.5](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#095)

#### Compatibility notes

Expand All @@ -62,9 +82,9 @@ Component | Version

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.9.3](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#093)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.9.4](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#094)
[create-electric-app](https://www.npmjs.com/package/create-electric-app) | [0.2.8](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#028)
[Sync service][1] | [0.9.3](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#093)
[TypeScript client][2] | [0.9.4](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#094)
[create-electric-app][3] | [0.2.8](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#028)

#### Compatibility notes

Expand All @@ -91,10 +111,10 @@ This release introduces a whole new client CLI, experimental support for enum ty

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.9.1](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#091)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.9.1](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#091)
[create-electric-app](https://www.npmjs.com/package/create-electric-app) | [0.2.5](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#025)
[@electric-sql/prisma-generator](https://www.npmjs.com/package/@electric-sql/prisma-generator) | [1.1.3](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#113)
[Sync service][1] | [0.9.1](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#091)
[TypeScript client][2] | [0.9.1](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#091)
[create-electric-app][3] | [0.2.5](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#025)
[@electric-sql/prisma-generator][4] | [1.1.3](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#113)

#### Compatibility notes

Expand Down Expand Up @@ -126,10 +146,10 @@ This release improves data model and deployment compatibility, including support

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.8.1](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#081)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.8.2](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#082)
[create-electric-app](https://www.npmjs.com/package/create-electric-app) | [0.2.2](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#022)
[@electric-sql/prisma-generator](https://www.npmjs.com/package/@electric-sql/prisma-generator) | [1.1.2](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#112)
[Sync service][1] | [0.8.1](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#081)
[TypeScript client][2] | [0.8.2](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#082)
[create-electric-app][3] | [0.2.2](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#022)
[@electric-sql/prisma-generator][4] | [1.1.2](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#112)

#### Compatibility notes

Expand All @@ -152,10 +172,10 @@ Major highlights of this release are the introduction of the Migrations proxy an

Component | Version
--------- | -------
[Sync service](https://hub.docker.com/r/electricsql/electric/tags) | [0.7.0](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#070)
[TypeScript client](https://www.npmjs.com/package/electric-sql) | [0.7.0](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#070)
[create-electric-app](https://www.npmjs.com/package/create-electric-app) | [0.2.0](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#020)
[@electric-sql/prisma-generator](https://www.npmjs.com/package/@electric-sql/prisma-generator) | [1.1.0](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#110)
[Sync service][1] | [0.7.0](https://github.com/electric-sql/electric/blob/main/components/electric/CHANGELOG.md#070)
[TypeScript client][2] | [0.7.0](https://github.com/electric-sql/electric/blob/main/clients/typescript/CHANGELOG.md#070)
[create-electric-app][3] | [0.2.0](https://github.com/electric-sql/electric/blob/main/examples/starter/CHANGELOG.md#020)
[@electric-sql/prisma-generator][4] | [1.1.0](https://github.com/electric-sql/electric/blob/main/generator/CHANGELOG.md#110)

#### Compatibility notes

Expand All @@ -176,3 +196,8 @@ Component | Version
[Announcement post](/blog/2023/09/20/introducing-electricsql-v0.6).

The first public release of ElectricSQL as a self-hosted sync layer on top of PostgreSQL.

[1]: https://hub.docker.com/r/electricsql/electric/tags
[2]: https://www.npmjs.com/package/electric-sql
[3]: https://www.npmjs.com/package/create-electric-app
[4]: https://www.npmjs.com/package/@electric-sql/prisma-generator

0 comments on commit 99dfabd

Please sign in to comment.