Changelog - fleXRPL/github-mcp GitHub Wiki

Changelog

All notable changes to the GitHub MCP Server will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Initial project setup
  • Basic server implementation
  • Repository management tools
  • Issue management tools
  • Pull request management tools
  • Content management tools
  • GitHub authentication using githubauthlib
  • Server-Sent Events support
  • Comprehensive documentation
  • Wiki pages
  • Security documentation
  • API reference
  • Architecture documentation
  • FAQ

Changed

  • Switched from PAT to githubauthlib for authentication
  • Improved error handling
  • Enhanced documentation
  • Updated security practices

Fixed

  • Authentication token handling
  • Rate limiting implementation
  • Error response formatting
  • Documentation links

[0.1.0] - 2024-03-20

Added

  • Initial release
  • FastAPI-based server
  • Basic tool implementation
  • GitHub API integration
  • Authentication system
  • Tool registry
  • SSE support
  • Basic documentation
  • Test suite
  • CI/CD setup

Features

  • Repository tools
    • List repositories
    • Get repository details
  • Issue tools
    • List issues
    • Create issues
  • Pull request tools
    • List pull requests
    • Create pull requests
  • Content tools
    • Get file content
    • List directory contents

Security

  • System keychain integration
  • Token management
  • Rate limiting
  • Input validation
  • Response sanitization

Documentation

  • README
  • API documentation
  • Installation guide
  • Usage examples
  • Security guidelines

Version History

0.1.0 (2024-03-20)

  • Initial release
  • Basic server implementation
  • Core tool set
  • Documentation

0.2.0 (Planned)

  • Enhanced error handling
  • Additional tools
  • Performance improvements
  • Extended documentation

0.3.0 (Planned)

  • Advanced features
  • UI improvements
  • Security enhancements
  • Community tools

Release Process

  1. Version Bumping

    • Update version in pyproject.toml
    • Update version in documentation
    • Create version tag

  2. Release Notes

    • Update changelog
    • Document changes
    • List new features
    • Note breaking changes

  3. Distribution

    • Build package
    • Upload to PyPI
    • Update documentation
    • Announce release

  4. Post-Release

    • Monitor feedback
    • Address issues
    • Plan next release
    • Update roadmap

Breaking Changes

0.1.0 to 0.2.0

  • None planned

0.2.0 to 0.3.0

  • TBD based on feedback

Deprecation Policy

  1. Announcement

    • Document deprecation
    • Provide migration guide
    • Set removal timeline

  2. Timeline

    • Announce in changelog
    • Mark as deprecated
    • Remove in next major version

  3. Migration

    • Provide alternatives
    • Update documentation
    • Support migration

Roadmap

Short Term (0.2.0)

  • Enhanced error handling
  • Additional tools
  • Performance improvements
  • Extended documentation

Medium Term (0.3.0)

  • Advanced features
  • UI improvements
  • Security enhancements
  • Community tools

Long Term (1.0.0)

  • Production readiness
  • Enterprise features
  • Advanced security
  • Comprehensive tooling

Contributing to Changelog

  1. Format

    • Follow Keep a Changelog
    • Use semantic versioning
    • Categorize changes

  2. Categories

    • Added
    • Changed
    • Deprecated
    • Removed
    • Fixed
    • Security

  3. Guidelines

    • Be specific
    • Include references
    • Note breaking changes
    • Link to issues

Related Documentation