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.

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

docs: upgrade breaking change description #8012

Merged
merged 8 commits into from
Sep 29, 2024
6 changes: 5 additions & 1 deletion website/docs/en/blog/announcing-1-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -207,11 +207,15 @@ Rspack provides some experimental features that can be used via the [experiments

#### SWC related features

Rspack is built on SWC, which is currently in the pre-1.0 phase. To keep up with the fixes and improvements in SWC, we regularly update the SWC version. This may include some breaking changes in SWC or break some versions of the SWC Wasm plugins. In such cases, we will release a minor version of Rspack and add a note to the changelog.
Rspack is built on SWC, which is currently in the pre-1.0 phase. To keep up with the fixes and improvements in SWC, we regularly update the SWC version. This may include some breaking changes in SWC or break some versions of the SWC Wasm plugins. In such cases, we will release a minor version of Rspack and add a note to the changelog, if upgrade SWC doesn't contains breaking change we may upgrade SWC in patch or minor version.
hardfist marked this conversation as resolved.
Show resolved Hide resolved

#### Types

In minor releases, the types exported by Rspack may change for the following reasons:

- TypeScript itself does not follow semver. It may introduce some breaking changes in minor releases that require Rspack to adjust its types.
- Rspack may use some features introduced in higher versions of TypeScript, which could affect projects using lower versions of TypeScript.

#### Fix Bug for Webpack Compatibility
hardfist marked this conversation as resolved.
Show resolved Hide resolved

If previous versions incorrectly implemented Webpack's API, we may fix it and align the behavior with Webpack's API in non-major version.
hardfist marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 6 additions & 2 deletions website/docs/zh/blog/announcing-1-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -207,11 +207,15 @@ Rspack 提供了一些实验性特性,这些特性可以通过 [experiments](h

#### SWC 相关特性

Rspack 基于 SWC 实现,而 SWC 目前处于 pre-1.0 阶段。为了及时地跟进 SWC 的修复和优化,我们会定期升级 SWC 版本,这可能会包含 SWC 的一些不兼容变更,或是导致低版本的 SWC Wasm 插件不可用。在这种情况下,我们会发布 Rspack 的 minor 版本并在更新日志中说明。
Rspack 基于 SWC 实现,而 SWC 目前处于 pre-1.0 阶段。为了及时地跟进 SWC 的修复和优化,我们会定期升级 SWC 版本,这可能会包含 SWC 的一些不兼容变更,或是导致低版本的 SWC Wasm 插件不可用。在这种情况下,如果 swc 升级包含 breaking change 我们会发布 Rspack 的 minor 版本,并在更新日志中说明, 如果 swc 升级不包含 breaking change 则我们可能会发布在 Rspack 的 patch 或者 minor 版本
hardfist marked this conversation as resolved.
Show resolved Hide resolved

#### TS 类型

e
hardfist marked this conversation as resolved.
Show resolved Hide resolved
在 minor 版本中,Rspack 导出的类型可能会发生变化,这是因为:

- TypeScript 自身不遵循 semver,它可能在 minor 版本引入一些不兼容变更,使得 Rspack 需要调整类型。
- Rspack 可能会利用一些高版本 TypeScript 引入的特性,对一些使用低版本 TypeScript 的项目造成影响。

#### 修复兼容 Webpack 的 Bug
hardfist marked this conversation as resolved.
Show resolved Hide resolved

如果在以前版本错误的实现了 Webpack 的 API,那么我们可能在非 major 版本进行修复并对齐 Webpack API 的行为。
hardfist marked this conversation as resolved.
Show resolved Hide resolved
Loading