Skip to content

Conversation

@tpayet
Copy link
Member

@tpayet tpayet commented Jun 6, 2025

Summary

This PR prepares for version 0.5.0 release and documents the automated release process for future maintainers.

Changes

Version Bump

  • Incremented version: 0.4.0 → 0.5.0 in pyproject.toml
  • Semantic versioning: MINOR version bump for new delete-index MCP tool feature
  • Triggers automated release: This will automatically publish to PyPI when merged to main

Release Process Documentation

Added comprehensive Release Process section to README.md covering:

📋 Process Overview

  • Automated publishing via GitHub Actions when version changes on main
  • Version detection by comparing pyproject.toml changes
  • PyPI publishing using trusted publishing (no manual API keys)

🔢 Versioning Guidelines

  • Semantic Versioning (MAJOR.MINOR.PATCH) with clear examples
  • Guidelines for when to use PATCH vs MINOR vs MAJOR increments

📝 Step-by-Step Instructions

  • Branch creation from latest main
  • Version update in pyproject.toml
  • PR workflow with review and merge process
  • Verification steps after release

🔧 Troubleshooting Guide

  • Common issues and solutions for failed releases
  • Debugging steps for GitHub Actions and PyPI problems

💡 Usage Examples

  • Development vs production installation methods
  • Specific version installation commands

Documentation Updates

  • Added delete-index tool to Available Tools section (was missing from previous PR)
  • Updated tool count to reflect new delete-index functionality

Release Impact

⚠️ Important: Merging this PR will trigger the automated release pipeline and publish version 0.5.0 to PyPI.

What happens when merged:

  1. GitHub Action triggers on main branch push
  2. Detects version change from 0.4.0 to 0.5.0
  3. Builds Python package using official build tools
  4. Publishes to PyPI at https://pypi.org/p/meilisearch-mcp
  5. Makes v0.5.0 available via pip install meilisearch-mcp

New features in 0.5.0:

  • delete-index MCP tool - allows users to delete Meilisearch indexes through Claude/MCP clients
  • Comprehensive test coverage - 6 new tests for delete functionality
  • Proper error handling - validates input and handles edge cases

Testing

  • ✅ All 22 tests pass including new delete-index tests
  • ✅ Code formatted with Black
  • ✅ Version bump verified in pyproject.toml
  • ✅ Documentation thoroughly reviewed

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

    • Updated the README to include information about the new index management tool, delete-index.
    • Added a comprehensive "Release Process" section detailing the automated release workflow, versioning guidelines, and troubleshooting tips.
    • Clarified installation methods for development and production environments.
  • Chores

    • Updated the project version to 0.5.0.

- 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]>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 6, 2025

Walkthrough

The README was updated to document a new delete-index tool for index management and to add a detailed "Release Process" section outlining the automated versioning and publishing workflow. The project's version was incremented from 0.4.0 to 0.5.0 in the pyproject.toml file, with no other configuration changes.

Changes

File(s) Change Summary
README.md Added documentation for delete-index tool and a comprehensive "Release Process" section.
pyproject.toml Updated project version from 0.4.0 to 0.5.0.

Poem

A hop and a skip, the version jumps high,
With docs for releases now clear as the sky.
A tool to delete, an index with grace,
Instructions for publishing neatly in place.
The README now sparkles, the project feels new—
Onward and upward, with each version we hop through!
🐇✨


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.yml a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0c5b9a9 and 5b44ab7.

📒 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 new delete-index feature and align with semantic versioning.

README.md (7)

205-205: Ensure implementation exists for delete-index
The docs now list a delete-index tool. 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 referencing gh CLI 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.

@tpayet tpayet merged commit 5295eb6 into main Jun 6, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants