Skip to content

Commit

Permalink
Merge branch 'main' into release/1-0-0-alpha-0
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored Jun 28, 2024
2 parents 0731801 + b8c1ce6 commit 32c0982
Show file tree
Hide file tree
Showing 11 changed files with 75 additions and 9 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ jobs:
name: Release
permissions:
contents: write
# To publish packages with provenance
id-token: write
runs-on: ubuntu-latest
needs: build
if: ${{ github.event_name == 'workflow_dispatch' }}
Expand Down
32 changes: 32 additions & 0 deletions website/docs/en/contribute/development/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,35 @@ The [nightly release workflow](https://github.com/web-infra-dev/rspack/actions/w
is triggered every day at UTC 16:00:07, which is 00:07 AM Beijing Time (offset with an odd minute to avoid cron jobs firing off at the same time).

The nightly build fully replicates the full release build for catching errors early.

## Canary

[canary release workflow](https://github.com/web-infra-dev/rspack/actions/workflows/release-canary.yml) requires manual triggering.

## Using nightly/canary version

When releasing the nightly/canary versions of Rspack, the package name will be appended with the `-canary` suffix. You need to use the overrides feature of package managers like npm, yarn, or pnpm to use these versions.

Take pnpm as an example:

```json title=package.json
{
"pnpm": {
"overrides": {
"@rspack/binding": "npm:@rspack/binding-canary@nightly",
"@rspack/core": "npm:@rspack/core-canary@nightly",
"@rspack/plugin-react-refresh": "npm:@rspack/plugin-react-refresh@nightly"
},
"peerDependencyRules": {
"allowAny": ["@rspack/*"]
}
}
}
```

The Rspack community provides the [install-rspack](https://github.com/rspack-contrib/install-rspack) tool to quickly modify the Rspack version:

```shell
npx install-rspack --version nightly # Get latest nightly npm tag version
npx install-rspack --version 0.7.5-canary-d614005-20240625082730 # A specific canary version
```
2 changes: 1 addition & 1 deletion website/docs/en/contribute/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Every single contribution counts and helps us take Rspack to the next level.
## Asking Questions

If you have any questions,
please do not hesitate to ask in either the [Discord](https://discord.gg/79ZZ66GH9E) support channel or on the [GitHub discussion board](https://github.com/web-infra-dev/rspack/discussions).
please do not hesitate to ask in either the [Discord](https://discord.gg/sYK4QjyZ4V) support channel or on the [GitHub discussion board](https://github.com/web-infra-dev/rspack/discussions).

### Minimal reproduction

Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/guide/start/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ Rspack and Rollup are both bundling tools, but they focus on different areas. Ro

Please read [Quick start](/guide/start/quick-start) to start using Rspack.

Welcome to the [GitHub Discussions](https://github.com/web-infra-dev/rspack/discussions) and [Discord](https://discord.gg/79ZZ66GH9E) to communicate with us.
Welcome to the [GitHub Discussions](https://github.com/web-infra-dev/rspack/discussions) and [Discord](https://discord.gg/sYK4QjyZ4V) to communicate with us.
2 changes: 1 addition & 1 deletion website/docs/en/misc/team/join-us.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ Please send your resume to **`[email protected]`** with the subjec

If you have any questions about the position or the team, feel free to communicate with us through the following channels:

- [Discord](https://discord.gg/VjNu24wzvs)
- [Discord](https://discord.gg/sYK4QjyZ4V)
- [Feishu Group](https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=131he762-7608-4553-825d-02a0be3ffe75)
34 changes: 33 additions & 1 deletion website/docs/zh/contribute/development/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- `nightly`
- `canary`

## latest 的全量发布
## Latest 版本全量发布

[全量发布工作流](https://github.com/web-infra-dev/rspack/actions/workflows/release.yml?query=is%3Asuccess)
目前在每个周二被手动触发,配合全量发布的 release notes。
Expand All @@ -31,3 +31,35 @@
在每天的 UTC 16:00:07 被触发,是 北京时间的凌晨 00:07 (偏移奇数分钟以避免 cron 作业同时触发)。

nightly 构建完全复制了全量发布构建,以便尽早发现错误。

## Canary

[canary 发布工作流](https://github.com/web-infra-dev/rspack/actions/workflows/release-canary.yml) 需要手动触发。

## 使用 nightly/canary 版本

在发布 Rspack 的 nightly/canary 版本时,发布的包名会被添加 `-canary` 后缀,你需要配合包管理器 npm / yarn / pnpm 的 overrides 功能来使用这些版本。

以 pnpm 为例:

```json title=package.json
{
"pnpm": {
"overrides": {
"@rspack/binding": "npm:@rspack/binding-canary@nightly",
"@rspack/core": "npm:@rspack/core-canary@nightly",
"@rspack/plugin-react-refresh": "npm:@rspack/plugin-react-refresh@nightly"
},
"peerDependencyRules": {
"allowAny": ["@rspack/*"]
}
}
}
```

Rspack 社区提供了 [install-rspack](https://github.com/rspack-contrib/install-rspack) 工具来快速修改 Rspack 版本:

```shell
npx install-rspack --version nightly # Get latest nightly npm tag version
npx install-rspack --version 0.7.5-canary-d614005-20240625082730 # A specific canary version
```
2 changes: 1 addition & 1 deletion website/docs/zh/contribute/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## 提出问题

如果您遇到任何问题,请随时在 [Discord](https://discord.gg/79ZZ66GH9E) 中的 support 频道或 [GitHub discussion board](https://github.com/web-infra-dev/rspack/discussions) 提问。
如果您遇到任何问题,请随时在 [Discord](https://discord.gg/sYK4QjyZ4V) 中的 support 频道或 [GitHub discussion board](https://github.com/web-infra-dev/rspack/discussions) 提问。

### 最小复现

Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/guide/start/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,4 @@ Rspack 和 Rollup 虽然都是打包工具,但是两者的侧重领域不同

请阅读 [快速上手](/guide/start/quick-start) 来开始使用 Rspack。

欢迎到 [GitHub Discussions](https://github.com/web-infra-dev/rspack/discussions)[Discord](https://discord.gg/79ZZ66GH9E) 来与我们交流。
欢迎到 [GitHub Discussions](https://github.com/web-infra-dev/rspack/discussions)[Discord](https://discord.gg/sYK4QjyZ4V) 来与我们交流。
2 changes: 1 addition & 1 deletion website/docs/zh/misc/team/join-us.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ Web Infra 团队正在寻求经验丰富的前端工程师,来共同打造高

如果你对岗位或团队有任何疑问,欢迎通过以下渠道和我们交流:

- [Discord](https://discord.gg/se2nnYdUtd)
- [Discord](https://discord.gg/sYK4QjyZ4V)
- [飞书群](https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=131he762-7608-4553-825d-02a0be3ffe75)
2 changes: 1 addition & 1 deletion website/rspress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export default defineConfig({
{
icon: 'discord',
mode: 'link',
content: 'https://discord.gg/79ZZ66GH9E',
content: 'https://discord.gg/sYK4QjyZ4V',
},
{
icon: 'twitter',
Expand Down
2 changes: 1 addition & 1 deletion website/theme/components/HomeFooter/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ function useFooterData() {
},
{
title: 'Discord',
link: 'https://discord.gg/ab2Rv4BXwf',
link: 'https://discord.gg/sYK4QjyZ4V',
},
{
title: 'Twitter (X)',
Expand Down

0 comments on commit 32c0982

Please sign in to comment.