docs: Update the release version document - #967
Open
delei wants to merge 3 commits into
Open
Conversation
Member
Author
|
Please first merge the PR #966 to address the |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the release-version documentation (English + Simplified Chinese) to reflect a more detailed, step-by-step release manager workflow, including expanded GPG key handling, mailing-list templates, and artifact preparation guidance.
Changes:
- Expanded PGP/GPG key generation and publishing steps (including keyserver and GitHub upload guidance).
- Reworked the release process sections into a more structured flow (discussion → material prep → community vote → incubator vote → finalization/announce), with updated email templates.
- Added/clarified SVN and staging repository操作说明 and caveats for building clean source artifacts.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/release/release-version.md | Updates the zh-CN release guide with expanded key management, vote流程与邮件模板、以及发布收尾说明。 |
| website/community/release/release-version.md | Updates the English release guide with the same expanded流程与模板内容。 |
Comments suppressed due to low confidence (3)
website/community/release/release-version.md:708
- The announcement template links Release Notes to
.../tag/x.x.x/, but elsewhere in this document the release tag placeholder isvx.x.x(v-prefixed). Aligning the placeholder/tag format here avoids confusion during release.
https://github.com/apache/fesod/releases/tag/x.x.x/
website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/release/release-version.md:497
- 结果邮件模板里
${RELEASE_VERSION}-RCN被重复了一次（-RCN-RCN），会导致最终邮件内容错误。
The vote to release Apache Fesod (Incubating) ${RELEASE_VERSION}-RCN-RCN has
website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/release/release-version.md:691
- 版本公示邮件模板的 Release Notes 使用
.../tag/x.x.x/，但文档其他位置使用vx.x.x（v 前缀）作为 tag 占位符。建议统一 tag 规则，避免发布时填错链接。
https://github.com/apache/fesod/releases/tag/x.x.x/
|
|
||
| Release Notes: | ||
| https://github.com/apache/fesod/releases/tag/2.0.0-incubating-rc1 | ||
| https://github.com/apache/fesod/releases/tag/2.0.0--rc1 |
|
|
||
| ```text | ||
| [root@localhost ~]# gpg --list-signatures --keyid-format LONG | ||
| #### 1.2.3 上传公钥 |
|
|
||
| Release Notes: | ||
| https://github.com/apache/fesod/releases/tag/2.0.0-incubating-rc1 | ||
| https://github.com/apache/fesod/releases/tag/2.0.0--rc1 |
|
|
||
| ## 5 孵化器投票 | ||
|
|
||
| 社区投票通过并完成后，需要想孵化器邮件列表发起投票。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the pull request
As title.
What's changed?
Summarizing my experience as the version manager in the previous version, and improving some details of the version release document.
AI Usage Statement
The English version of the document was assisted by AI for translation, but the final content of the article was signed and approved by me, and I am responsible for it.
Checklist