Skip to content

docs: update README for v3.3.2 tool releases - #3597

Open
AlexStocks wants to merge 1 commit into
developfrom
codex/docs-readme-v3.3.2-tools
Open

AlexStocks wants to merge 1 commit into
developfrom
codex/docs-readme-v3.3.2-tools

Conversation

@AlexStocks

Copy link
Copy Markdown
Contributor

What changed

  • align the English and Chinese README entry points with the published Dubbo-go v3.3.2 release
  • document the Go 1.25 minimum required by the v3.3.2 module
  • add the missing Chinese recent-updates section and link the canonical changelog/release
  • link the released cross-platform archives for dubbogo-cli, protoc-gen-go-triple, protoc-gen-triple-openapi, and imports-formatter
  • document dubbogo-cli install all as the companion-tool installation path

The existing tool descriptions and benchmark entry remain unchanged.

Follow-up to #3585.

Release evidence

  • Dubbo-go: v3.3.2, final Release
  • dubbogo-cli: v1.0.1
  • protoc-gen-go-triple: v3.3.2
  • protoc-gen-triple-openapi: v3.3.2
  • imports-formatter: v1.0.11

Each tool Release currently publishes eight archives covering Darwin, Linux, and Windows architectures. The documented versions also match the version constants in develop.

Validation

  • git diff --check origin/develop..HEAD
  • verified the committed file set is exactly README.md and README_CN.md
  • verified both READMEs contain the same core/tool Release URLs, Go 1.25 requirement, and dubbogo-cli install all entry
  • verified all local Markdown link targets in both READMEs exist
  • queried the five GitHub Releases and confirmed they are final; each tool Release has eight assets
  • compared the four documented tool versions with their source constants

Go tests were not run because this PR changes Markdown only and does not modify executable code, configuration, dependencies, generators, or tests.

AI assistance

AI assistance: docs

Human verification: reviewed the complete diff and ran the validation commands listed above.

Keep the English and Chinese entry points aligned with the published 3.3.2 module and companion tool releases.

Document the Go 1.25 minimum, add the missing Chinese release summary, and link the four cross-platform tool archives without changing tool source docs or release notes.

Constraint: Limit the change to README.md and README_CN.md.

Confidence: high

Scope-risk: narrow

Tested: git diff --check; bilingual marker and local-link validation; GitHub Release state and asset-count checks; source-version comparison.

Not-tested: Go tests were not run because this commit changes Markdown only.

Co-authored-by: OmX <omx@oh-my-codex.dev>
Signed-off-by: Xin.Zh <alexstocks@foxmail.com>
@sonarqubecloud

sonarqubecloud Bot commented Aug 5, 2026

Copy link
Copy Markdown

@codecov-commenter

codecov-commenter commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.77%. Comparing base (60d1c2a) to head (bba9ca0).
⚠️ Report is 975 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3597      +/-   ##
===========================================
+ Coverage    46.76%   53.77%   +7.00%     
===========================================
  Files          295      474     +179     
  Lines        17172    36283   +19111     
===========================================
+ Hits          8031    19510   +11479     
- Misses        8287    15205    +6918     
- Partials       854     1568     +714     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AlexStocks
AlexStocks requested review from Alanxtl and a lite review from Copilot August 5, 2026 05:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the root documentation to reflect the published Dubbo-go v3.3.2 release and companion tool releases, including the new minimum Go version and refreshed release links for prebuilt tool archives.

Changes:

  • Updates the v3.3.2 “Recent Updates” entry to link the release/tag and add an explicit upgrade note (including Go 1.25+ requirement).
  • Bumps prerequisites to Go 1.25+ in both READMEs.
  • Adds GitHub Release links for prebuilt archives of dubbogo-cli, protoc-gen-go-triple, protoc-gen-triple-openapi, and imports-formatter, plus dubbogo-cli install all guidance.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
README.md Updates recent-updates content, Go version prerequisite, and adds tool release archive links/installation guidance.
README_CN.md Adds/updates recent-updates content, Go version prerequisite, and adds tool release archive links/installation guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README_CN.md
Comment thread README.md
Comment on lines +128 to +136
Prebuilt archives for Darwin, Linux, and Windows are available from GitHub Releases:

- [dubbogo-cli v1.0.1](https://github.com/apache/dubbo-go/releases/tag/tools/dubbogo-cli/v1.0.1)
- [protoc-gen-go-triple v3.3.2](https://github.com/apache/dubbo-go/releases/tag/tools/protoc-gen-go-triple/v3.3.2)
- [protoc-gen-triple-openapi v3.3.2](https://github.com/apache/dubbo-go/releases/tag/tools/protoc-gen-triple-openapi/v3.3.2)
- [imports-formatter v1.0.11](https://github.com/apache/dubbo-go/releases/tag/tools/imports-formatter/v1.0.11)

After installing `dubbogo-cli`, run `dubbogo-cli install all` to install the companion generators and formatter. Source installation commands are documented in each tool's README.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这些不需要

@Alanxtl Alanxtl added 📒 Documentation issues with documentations 3.3.3 version 3.3.3 labels Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.3.3 version 3.3.3 📒 Documentation issues with documentations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants