Skip to content

Commit

Permalink
docs: add changelog for verison 4.8.1
Browse files Browse the repository at this point in the history
  • Loading branch information
darrachequesne committed Nov 21, 2024
1 parent 01cd3f7 commit 04b10ed
Show file tree
Hide file tree
Showing 10 changed files with 142 additions and 16 deletions.
5 changes: 3 additions & 2 deletions docs/categories/02-Server/server-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import TabItem from '@theme/TabItem';

:::info

The latest release is currently `4.8.0`, released in September 2024.
The latest release is currently `4.8.1`, released in October 2024.

You can find the release notes [here](../../changelog/4.8.0.md).
You can find the release notes [here](../../changelog/4.8.1.md).

:::

Expand Down Expand Up @@ -266,6 +266,7 @@ The `engine.io` package brings the engine that is responsible for managing the l

| `socket.io` version | `engine.io` version | `ws` version |
|---------------------|---------------------|--------------|
| `4.8.x` | `6.6.x` | `8.17.x` |
| `4.7.x` | `6.5.x` | `8.17.x` |
| `4.6.x` | `6.4.x` | `8.11.x` |
| `4.5.x` | `6.2.x` | `8.2.x` |
Expand Down
2 changes: 1 addition & 1 deletion docs/categories/03-Client/client-initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In the examples below, the `io` object comes either from:

```html
<script type="module">
import { io } from "https://cdn.socket.io/4.8.0/socket.io.esm.min.js";
import { io } from "https://cdn.socket.io/4.8.1/socket.io.esm.min.js";
</script>
```

Expand Down
13 changes: 7 additions & 6 deletions docs/categories/03-Client/client-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import TabItem from '@theme/TabItem';

:::info

The latest release is currently `4.8.0`, released in September 2024.
The latest release is currently `4.8.1`, released in October 2024.

You can find the release notes [here](../../changelog/4.8.0.md).
You can find the release notes [here](../../changelog/4.8.1.md).

:::

Expand Down Expand Up @@ -106,14 +106,14 @@ const io = new Server({
You can also include the client bundle from a CDN:

```html
<script src="https://cdn.socket.io/4.8.0/socket.io.min.js" integrity="sha384-OoIbkvzsFFQAG88r+IqMAjyOtYDPGO0cqK5HF5Uosdy/zUEGySeAzytENMDynREd" crossorigin="anonymous"></script>
<script src="https://cdn.socket.io/4.8.1/socket.io.min.js" integrity="sha384-mkQ3/7FUtcGyoppY6bz/PORYoGqOl7/aSUMn2ymDOJcapfS6PHqxhRTMh1RR0Q6+" crossorigin="anonymous"></script>
```

Socket.IO is also available from other CDN:

- cdnjs: https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.8.0/socket.io.min.js
- jsDelivr: https://cdn.jsdelivr.net/npm/socket.io-client@4.8.0/dist/socket.io.min.js
- unpkg: https://unpkg.com/socket.io-client@4.8.0/dist/socket.io.min.js
- cdnjs: https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.8.1/socket.io.min.js
- jsDelivr: https://cdn.jsdelivr.net/npm/socket.io-client@4.8.1/dist/socket.io.min.js
- unpkg: https://unpkg.com/socket.io-client@4.8.1/dist/socket.io.min.js

There are several bundles available:

Expand Down Expand Up @@ -197,6 +197,7 @@ The `engine.io-client` package brings the engine that is responsible for managin

| `socket.io-client` version | `engine.io-client` version | `ws` version<sup>1</sup> |
|----------------------------|----------------------------|--------------------------|
| `4.8.x` | `6.6.x` | `8.17.x` |
| `4.7.x` | `6.5.x` | `8.17.x` |
| `4.6.x` | `6.4.x` | `8.11.x` |
| `4.5.x` | `6.2.x` | `8.2.x` |
Expand Down
8 changes: 4 additions & 4 deletions docs/categories/06-Advanced/custom-parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,10 @@ const socket = io("https://example.com", {

In the browser, there is now an official bundle which includes this parser:

- https://cdn.socket.io/4.8.0/socket.io.msgpack.min.js
- cdnjs: https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.8.0/socket.io.msgpack.min.js
- jsDelivr: https://cdn.jsdelivr.net/npm/socket.io-client@4.8.0/dist/socket.io.msgpack.min.js
- unpkg: https://unpkg.com/socket.io-client@4.8.0/dist/socket.io.msgpack.min.js
- https://cdn.socket.io/4.8.1/socket.io.msgpack.min.js
- cdnjs: https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.8.1/socket.io.msgpack.min.js
- jsDelivr: https://cdn.jsdelivr.net/npm/socket.io-client@4.8.1/dist/socket.io.msgpack.min.js
- unpkg: https://unpkg.com/socket.io-client@4.8.1/dist/socket.io.msgpack.min.js

In that case, you don't need to specify the `parser` option.

Expand Down
31 changes: 31 additions & 0 deletions docs/changelog/4.8.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Version 4.8.1
sidebar_label: 4.8.1 (October 25, 2024)
sidebar_position: 91
toc_max_heading_level: 4
---

*October 25, 2024*

## Server

Due to a change in the bundler configuration, the production bundle (`socket.io.min.js`) did not support sending and receiving binary data in version `4.8.0`. This is now fixed.

### Dependencies

- [`engine.io@~6.6.0`](https://github.com/socketio/engine.io/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)



## Client

### Bug Fixes

* **bundle:** do not mangle the "_placeholder" attribute ([ca9e994](https://github.com/socketio/socket.io/commit/ca9e994815aa2e31e0342e37ccdc2e9e8c5fd13c))


### Dependencies

- [`engine.io-client@~6.6.1`](https://github.com/socketio/engine.io-client/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)
4 changes: 2 additions & 2 deletions docs/client-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ An ESM bundle is also available since version [4.3.0](/blog/socket-io-4-3-0/):

```html
<script type="module">
import { io } from "https://cdn.socket.io/4.8.0/socket.io.esm.min.js";
import { io } from "https://cdn.socket.io/4.8.1/socket.io.esm.min.js";
const socket = io();
</script>
Expand All @@ -36,7 +36,7 @@ With an [import map](https://caniuse.com/import-maps):
<script type="importmap">
{
"imports": {
"socket.io-client": "https://cdn.socket.io/4.8.0/socket.io.esm.min.js"
"socket.io-client": "https://cdn.socket.io/4.8.1/socket.io.esm.min.js"
}
}
</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/04-integrating-socket-io.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ If you would like to use the local version of the client-side JS file, you can f
:::tip
You can also use a CDN instead of the local files (e.g. `<script src="https://cdn.socket.io/4.8.0/socket.io.min.js"></script>`).
You can also use a CDN instead of the local files (e.g. `<script src="https://cdn.socket.io/4.8.1/socket.io.min.js"></script>`).
:::
Expand Down
31 changes: 31 additions & 0 deletions i18n/fr/docusaurus-plugin-content-docs/current/changelog/4.8.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Version 4.8.1
sidebar_label: 4.8.1 (October 25, 2024)
sidebar_position: 91
toc_max_heading_level: 4
---

*October 25, 2024*

## Server

Due to a change in the bundler configuration, the production bundle (`socket.io.min.js`) did not support sending and receiving binary data in version `4.8.0`. This is now fixed.

### Dependencies

- [`engine.io@~6.6.0`](https://github.com/socketio/engine.io/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)



## Client

### Bug Fixes

* **bundle:** do not mangle the "_placeholder" attribute ([ca9e994](https://github.com/socketio/socket.io/commit/ca9e994815aa2e31e0342e37ccdc2e9e8c5fd13c))


### Dependencies

- [`engine.io-client@~6.6.1`](https://github.com/socketio/engine.io-client/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Version 4.8.1
sidebar_label: 4.8.1 (October 25, 2024)
sidebar_position: 91
toc_max_heading_level: 4
---

*October 25, 2024*

## Server

Due to a change in the bundler configuration, the production bundle (`socket.io.min.js`) did not support sending and receiving binary data in version `4.8.0`. This is now fixed.

### Dependencies

- [`engine.io@~6.6.0`](https://github.com/socketio/engine.io/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)



## Client

### Bug Fixes

* **bundle:** do not mangle the "_placeholder" attribute ([ca9e994](https://github.com/socketio/socket.io/commit/ca9e994815aa2e31e0342e37ccdc2e9e8c5fd13c))


### Dependencies

- [`engine.io-client@~6.6.1`](https://github.com/socketio/engine.io-client/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Version 4.8.1
sidebar_label: 4.8.1 (October 25, 2024)
sidebar_position: 91
toc_max_heading_level: 4
---

*October 25, 2024*

## Server

Due to a change in the bundler configuration, the production bundle (`socket.io.min.js`) did not support sending and receiving binary data in version `4.8.0`. This is now fixed.

### Dependencies

- [`engine.io@~6.6.0`](https://github.com/socketio/engine.io/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)



## Client

### Bug Fixes

* **bundle:** do not mangle the "_placeholder" attribute ([ca9e994](https://github.com/socketio/socket.io/commit/ca9e994815aa2e31e0342e37ccdc2e9e8c5fd13c))


### Dependencies

- [`engine.io-client@~6.6.1`](https://github.com/socketio/engine.io-client/releases/tag/6.5.2) (no change)
- [`ws@~8.17.1`](https://github.com/websockets/ws/releases/tag/8.17.1) (no change)

0 comments on commit 04b10ed

Please sign in to comment.