Marcus/update readme on release #607
Merged
Conversation
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
- Add version update for root README.md UPM fixed version examples - Add version update for README-zh.md UPM and pip fixed version examples - Include README.md and README-zh.md in release commit
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR extends the release workflow so version bumps in the root and Chinese READMEs are automated alongside the server and package files, and updates the checked-in README examples to v9.1.0. Sequence diagram for updated release workflow version update stepsequenceDiagram
actor Developer
participant GitHubActions
participant ReleaseWorkflow
participant VersionUpdateStep
participant GitRepository
Developer->>GitHubActions: Push tag / trigger release
GitHubActions->>ReleaseWorkflow: Start release job
ReleaseWorkflow->>ReleaseWorkflow: Compute NEW_VERSION
ReleaseWorkflow->>VersionUpdateStep: Run version update script with NEW_VERSION
VersionUpdateStep->>GitRepository: Update MCPForUnity/package.json version
VersionUpdateStep->>GitRepository: Update Server/pyproject.toml version
VersionUpdateStep->>GitRepository: Update Server/README.md version references
VersionUpdateStep->>GitRepository: Update README.md fixed version examples
VersionUpdateStep->>GitRepository: Update README-zh.md fixed version examples
ReleaseWorkflow->>GitRepository: git add MCPForUnity/package.json
ReleaseWorkflow->>GitRepository: git add Server/pyproject.toml
ReleaseWorkflow->>GitRepository: git add Server/README.md
ReleaseWorkflow->>GitRepository: git add README.md
ReleaseWorkflow->>GitRepository: git add README-zh.md
ReleaseWorkflow->>GitRepository: Commit and push version bump
GitHubActions-->>Developer: Release pipeline completed
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
📝 WalkthroughWalkthroughRelease workflow updated to bump version references and commit documentation changes; Chinese README moved from repository root to Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The repeated
sedexpressions for updating versioned URLs in multiple READMEs could be extracted into a small script or looped over a list of files to reduce duplication and make future changes less error-prone. - The regexes assume strictly
x.y.zsemantic version tags; if you ever introduce pre-release tags or change tag format, you may want to centralize or loosen these patterns to avoid fragile replacements.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The repeated `sed` expressions for updating versioned URLs in multiple READMEs could be extracted into a small script or looped over a list of files to reduce duplication and make future changes less error-prone.
- The regexes assume strictly `x.y.z` semantic version tags; if you ever introduce pre-release tags or change tag format, you may want to centralize or loosen these patterns to avoid fragile replacements.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README-zh.md (1)
206-206: Missed version reference still shows v8.6.0.Line 206 contains an outdated
v8.6.0reference in the manual uvx command, while other version references in this file have been updated tov9.1.0. This creates an inconsistency. The release workflow's sed command (line 93 in release.yml) would update this in future releases, but the current PR leaves it outdated.📝 Suggested fix
-uvx --from "git+https://github.com/CoplayDev/unity-mcp@v8.6.0#subdirectory=Server" mcp-for-unity --transport http --http-url http://localhost:8080 +uvx --from "git+https://github.com/CoplayDev/unity-mcp@v9.1.0#subdirectory=Server" mcp-for-unity --transport http --http-url http://localhost:8080
- Move README-zh.md to docs/i18n/README-zh.md - Move development docs to docs/development/ (README-DEV.md, README-DEV-zh.md) - Move user guides to docs/guides/ (CLI_USAGE.md, CURSOR_HELP.md, MCP_CLIENT_CONFIGURATORS.md) - Move migration guides to docs/migrations/ (v5_MIGRATION.md, v6_NEW_UI_CHANGES.md, v8_NEW_NETWORKING_SETUP.md) - Move reference docs to docs/reference/ (CUSTOM_TOOLS.md, TELEMETRY.md) - Update all internal links in README
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.
Description
Update the example in the README with the latest version + re-organize docs so it's more structured
Type of Change
Changes Made
Change release logic and update docs
Testing/Screenshots/Recordings
N/A
Related Issues
N.A
Additional Notes
N/A
Summary by Sourcery
Automate README version updates in the release workflow and refresh fixed-version examples in the English and Chinese READMEs to the latest tag.
CI:
Documentation:
Summary by CodeRabbit
Chores
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.