blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs: add changelog notices (#13003)

Browse Source
This commit is contained in:
neverland 2024-07-14 18:12:14 +08:00 committed by GitHub
parent db4de574fe
commit 95b22e1583
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 12 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/release-tag.yml vendored
View File

@ -18,5 +18,3 @@ jobs:
uses: ncipollo/release-action@v1 uses: ncipollo/release-action@v1
with: with:
generateReleaseNotes: "true" generateReleaseNotes: "true"
body: |
> Please refer to [Changelog](https://vant-ui.github.io/vant/#/en-US/changelog) for all changes. | 请访问 [更新日志](https://vant-ui.github.io/vant/#/zh-CN/changelog) 了解所有更新。

63
packages/vant/docs/formatChangelog.mjs
View File

@ -1,63 +0,0 @@
/**
* This script is used to format changelog which is generated by GitHub
* because we need to paste it to the changelog page of Vant website.
*
* translation prompt:
* You are a professional software developer who is proficient in both English and Chinese. Please translate the following software changelog from English to Chinese, keeping the header of the commit information in English and the position of the contributor information unchanged.
*/
// paste changelog here
const changelog = ``;
changelog.split('\n').map((line) => {
// Skip unused lines
if (
line.startsWith('> Please refer to') ||
line.startsWith('release:') ||
line.includes("What's Changed") ||
line.includes('Full Changelog') ||
line.includes('docs(changelog)')
) {
return;
}
if (line.startsWith('<!-- Release notes generated')) {
const version = line.match(/v\d+\.\d+\.\d+/)[0];
if (version) {
console.log(`### ${version}`);
// log the current date
const now = new Date();
const padZero = (num) => (num < 10 ? `0${num}` : num);
console.log(
`\`${now.getFullYear()}-${padZero(now.getMonth() + 1)}-${padZero(
now.getDate(),
)}\``,
);
}
return;
}
// format title
if (line.startsWith('### ')) {
line = line.replace('### ', '#### ');
} else if (line.startsWith('## ')) {
line = line.replace('## ', '#### ');
}
// format PR link
const regex = /https:\/\/github\.com\/(\w+\/\w+)\/pull\/(\d+)/;
const match = line.match(regex);
const repoName = match ? match[1] : null;
const pullRequestNumber = match ? match[2] : null;
if (repoName && pullRequestNumber) {
line = line.replace(
regex,
`[#${pullRequestNumber}](https://github.com/${repoName}/pull/${pullRequestNumber})`,
);
}
// format author
line = line.replace(/@([\w-]+)/, '[@$1](https://github.com/$1)');
console.log(line);
});

50
packages/vant/docs/markdown/changelog.en-US.md
View File

@ -1,8 +1,12 @@
# Changelog # Changelog
### Tips ### Important Notice
The current document is the changelog of Vant 4, other versions: **To avoid redundant maintenance and reduce costs.**
**From v4.9.0, Vant's changelog will be published on [GitHub's Releases Page](https://github.com/youzan/vant/releases). This page will no longer be updated.**
The current document contains the changelog for Vant v4.0.0 ~ v4.9.0. For other versions, please refer to:
- [Vant 2 Changelog](/vant/v2/#/en-US/changelog) - [Vant 2 Changelog](/vant/v2/#/en-US/changelog)
- [Vant 3 Changelog](/vant/v3/#/en-US/changelog) - [Vant 3 Changelog](/vant/v3/#/en-US/changelog)
@ -19,48 +23,6 @@ Vant follows [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/).
## Details ## Details
### v4.9.1
`2024-06-02`
#### New Features 🎉
- feat(FloatingPanel): support header slot by [@chouchouji](https://github.com/chouchouji) in [#12897](https://github.com/youzan/vant/pull/12897)
- feat(AddressList): support multiple selection by [@jj56313751](https://github.com/jj56313751) in [#12887](https://github.com/youzan/vant/pull/12887)
- feat(cli): bump Rsbuild v0.7 by [@chenjiahan](https://github.com/chenjiahan) in [#12903](https://github.com/youzan/vant/pull/12903)
- feat: supports `imports` option for auto-import by [@zhaojjiang](https://github.com/zhaojjiang) in [#12861](https://github.com/youzan/vant/pull/12861)
#### Bug Fixes 🐞
- fix(cli): CSS preprocessor for scoped by [@zoy-l](https://github.com/zoy-l) in [#12860](https://github.com/youzan/vant/pull/12860)
- fix(area): columns-placeholder prop rendering error by [@yipl95](https://github.com/yipl95) in [#12857](https://github.com/youzan/vant/pull/12857)
- fix: VantImports type error by [@wChenonly](https://github.com/wChenonly) in [#12876](https://github.com/youzan/vant/pull/12876)
- fix(Stepper): set autocomplete to off by [@inottn](https://github.com/inottn) in [#12892](https://github.com/youzan/vant/pull/12892)
- fix(Tab): incorrect style by [@pany-ang](https://github.com/pany-ang) in [#12885](https://github.com/youzan/vant/pull/12885)
#### Document 📖
- docs: add ICP license by [@chenjiahan](https://github.com/chenjiahan) in [#12893](https://github.com/youzan/vant/pull/12893)
- docs: remove VantImports example by [@chenjiahan](https://github.com/chenjiahan) in [#12894](https://github.com/youzan/vant/pull/12894)
- docs: add new document site URL by [@chenjiahan](https://github.com/chenjiahan) in [#12902](https://github.com/youzan/vant/pull/12902)
#### Other Changes
- chore(deps): update dependency terser to ^5.31.0 by [@renovate](https://github.com/renovate) in [#12852](https://github.com/youzan/vant/pull/12852)
- chore(deps): update all patch dependencies by [@renovate](https://github.com/renovate) in [#12851](https://github.com/youzan/vant/pull/12851)
- chore(deps): update dependency eslint-plugin-vue to ^9.26.0 by [@renovate](https://github.com/renovate) in [#12864](https://github.com/youzan/vant/pull/12864)
- chore(deps): update all patch dependencies by [@renovate](https://github.com/renovate) in [#12862](https://github.com/youzan/vant/pull/12862)
- chore(deps): update pnpm to v9.1.2 by [@renovate](https://github.com/renovate) in [#12865](https://github.com/youzan/vant/pull/12865)
- chore(deps): update dependency commander to ^12.1.0 by [@renovate](https://github.com/renovate) in [#12884](https://github.com/youzan/vant/pull/12884)
- chore(deps): update all patch dependencies by [@renovate](https://github.com/renovate) in [#12883](https://github.com/youzan/vant/pull/12883)
#### New Contributors
- [@zhaojjiang](https://github.com/zhaojjiang) made their first contribution in [#12861](https://github.com/youzan/vant/pull/12861)
- [@yipl95](https://github.com/yipl95) made their first contribution in [#12857](https://github.com/youzan/vant/pull/12857)
- [@pany-ang](https://github.com/pany-ang) made their first contribution in [#12885](https://github.com/youzan/vant/pull/12885)
- [@jj56313751](https://github.com/jj56313751) made their first contribution in [#12887](https://github.com/youzan/vant/pull/12887)
### v4.9.0 ### v4.9.0
`2024-05-02` `2024-05-02`

50
packages/vant/docs/markdown/changelog.zh-CN.md
View File

@ -1,8 +1,12 @@
# 更新日志 # 更新日志
### 提示 ### 重要提示
当前文档为 Vant 4 的更新日志，其他版本请参考： **为了避免重复维护，降低维护成本。**
**从 v4.9.0 开始，Vant 的更新日志统一发布在 [GitHub 的 Releases 页面](https://github.com/youzan/vant/releases)，当前页面将不再更新。**
当前文档为 Vant v4.0.0 ~ v4.9.0 的的更新日志，其他版本请参考：
- [Vant 2 更新日志](/vant/v2/#/zh-CN/changelog) - [Vant 2 更新日志](/vant/v2/#/zh-CN/changelog)
- [Vant 3 更新日志](/vant/v3/#/zh-CN/changelog) - [Vant 3 更新日志](/vant/v3/#/zh-CN/changelog)
@ -19,48 +23,6 @@ Vant 遵循 [Semver](https://semver.org/lang/zh-CN/) 语义化版本规范。
## 更新内容 ## 更新内容
### v4.9.1
`2024-06-02`
#### New Features 🎉
- feat(FloatingPanel): 支持 header 插槽 by [@chouchouji](https://github.com/chouchouji) in [#12897](https://github.com/youzan/vant/pull/12897)
- feat(AddressList): 支持多重选择 by [@jj56313751](https://github.com/jj56313751) in [#12887](https://github.com/youzan/vant/pull/12887)
- feat(cli): 升级 Rsbuild 到 v0.7 by [@chenjiahan](https://github.com/chenjiahan) in [#12903](https://github.com/youzan/vant/pull/12903)
- feat: 支持自动导入的 `imports` 选项 by [@zhaojjiang](https://github.com/zhaojjiang) in [#12861](https://github.com/youzan/vant/pull/12861)
#### Bug Fixes 🐞
- fix(cli): 修复用于 scoped 的 CSS 预处理器问题 by [@zoy-l](https://github.com/zoy-l) in [#12860](https://github.com/youzan/vant/pull/12860)
- fix(area): 修复 columns-placeholder 属性渲染错误 by [@yipl95](https://github.com/yipl95) in [#12857](https://github.com/youzan/vant/pull/12857)
- fix: 修复 VantImports 的类型错误 by [@wChenonly](https://github.com/wChenonly) in [#12876](https://github.com/youzan/vant/pull/12876)
- fix(Stepper): 设置 autocomplete 为 off by [@inottn](https://github.com/inottn) in [#12892](https://github.com/youzan/vant/pull/12892)
- fix(Tab): 修复样式错误 by [@pany-ang](https://github.com/pany-ang) in [#12885](https://github.com/youzan/vant/pull/12885)
#### Document 📖
- docs: 添加 ICP 许可证 by [@chenjiahan](https://github.com/chenjiahan) in [#12893](https://github.com/youzan/vant/pull/12893)
- docs: 移除 VantImports 示例 by [@chenjiahan](https://github.com/chenjiahan) in [#12894](https://github.com/youzan/vant/pull/12894)
- docs: 添加新文档站点 URL by [@chenjiahan](https://github.com/chenjiahan) in [#12902](https://github.com/youzan/vant/pull/12902)
#### Other Changes
- chore(deps): 更新 terser 依赖到 ^5.31.0 by [@renovate](https://github.com/renovate) in [#12852](https://github.com/youzan/vant/pull/12852)
- chore(deps): 更新所有补丁依赖 by [@renovate](https://github.com/renovate) in [#12851](https://github.com/youzan/vant/pull/12851)
- chore(deps): 更新 eslint-plugin-vue 依赖到 ^9.26.0 by [@renovate](https://github.com/renovate) in [#12864](https://github.com/youzan/vant/pull/12864)
- chore(deps): 更新所有补丁依赖 by [@renovate](https://github.com/renovate) in [#12862](https://github.com/youzan/vant/pull/12862)
- chore(deps): 更新 pnpm 到 v9.1.2 by [@renovate](https://github.com/renovate) in [#12865](https://github.com/youzan/vant/pull/12865)
- chore(deps): 更新 commander 依赖到 ^12.1.0 by [@renovate](https://github.com/renovate) in [#12884](https://github.com/youzan/vant/pull/12884)
- chore(deps): 更新所有补丁依赖 by [@renovate](https://github.com/renovate) in [#12883](https://github.com/youzan/vant/pull/12883)
#### New Contributors
- [@zhaojjiang](https://github.com/zhaojjiang) made their first contribution in [#12861](https://github.com/youzan/vant/pull/12861)
- [@yipl95](https://github.com/yipl95) made their first contribution in [#12857](https://github.com/youzan/vant/pull/12857)
- [@pany-ang](https://github.com/pany-ang) made their first contribution in [#12885](https://github.com/youzan/vant/pull/12885)
- [@jj56313751](https://github.com/jj56313751) made their first contribution in [#12887](https://github.com/youzan/vant/pull/12887)
### v4.9.0 ### v4.9.0
`2024-05-02` `2024-05-02`