-
Notifications
You must be signed in to change notification settings - Fork 23
Release v0.5.0: Bump version and document release process #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Increment version from 0.4.0 to 0.5.0 for delete-index feature addition - Add comprehensive Release Process section to README.md covering: * Automated PyPI publishing workflow via GitHub Actions * Semantic versioning guidelines (MAJOR.MINOR.PATCH) * Step-by-step release instructions * Troubleshooting common release issues * Development vs production installation methods - Update Available Tools section to include delete-index tool - Verified all 22 tests pass after version bump This PR will trigger the automated release to PyPI once merged to main. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
WalkthroughThe README was updated to document a new Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
338-346: Address bare URL per markdown lint
The raw PyPI URL triggers MD034 (no-bare-urls). Wrap it or convert to a markdown link.Proposed diff:
- 3. Publish to PyPI at https://pypi.org/p/meilisearch-mcp + 3. Publish to PyPI at [meilisearch-mcp on PyPI](https://pypi.org/p/meilisearch-mcp)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
344-344: Bare URL used
null(MD034, no-bare-urls)
362-371: Link to release workflow file
Consider making.github/workflows/publish.ymla clickable link for quick reference.
382-387: Clarify installation methods by environment
The dev vs. production vs. pinned-version examples are useful. You might automate the pinned-version example to always reflect the current version.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(2 hunks)pyproject.toml(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
344-344: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (8)
pyproject.toml (1)
3-3: Confirm version bump
The version has been correctly incremented from 0.4.0 to 0.5.0 to reflect the newdelete-indexfeature and align with semantic versioning.README.md (7)
205-205: Ensure implementation exists fordelete-index
The docs now list adelete-indextool. Please verify that the source code includes this command handler and that the new tests cover its functionality.
291-293: Add 'Release Process' section header and intro
The new section clearly introduces the automated release workflow and its purpose.
295-301: Describe automated publishing workflow
The steps for build, publish, and GitHub release are concise and accurate.
302-316: Outline version detection & SemVer guidelines
Semantic Versioning guidance with examples is clear and correctly scoped to MAJOR.MINOR.PATCH.
318-336: Provide branch & PR creation steps
The CLI commands for branching, version update, and PR creation are correct. Consider linking or referencingghCLI docs for less-experienced contributors.
347-360: Detail release verification commands
Commands for checking workflow runs and installing the new version are clear and actionable.
372-380: Include troubleshooting tips
Common errors and debugging steps are well-documented and should help reduce release friction.
Summary
This PR prepares for version 0.5.0 release and documents the automated release process for future maintainers.
Changes
Version Bump
pyproject.tomldelete-indexMCP tool featureRelease Process Documentation
Added comprehensive Release Process section to README.md covering:
📋 Process Overview
pyproject.tomlchanges🔢 Versioning Guidelines
📝 Step-by-Step Instructions
🔧 Troubleshooting Guide
💡 Usage Examples
Documentation Updates
Release Impact
What happens when merged:
pip install meilisearch-mcpNew features in 0.5.0:
Testing
Future Maintenance
This documentation will help future maintainers understand and execute releases consistently. The process is now fully documented and automated.
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
delete-index.Chores