tree-sitter-analyzer 0.9.9__tar.gz → 1.1.0__tar.gz

{tree_sitter_analyzer-0.9.9 → tree_sitter_analyzer-1.1.0}/CHANGELOG.md

@@ -1,5 +1,91 @@
 # Changelog
 
+## [1.1.0] - 2025-08-24
+
+### 🚀 Major Release: GitFlow CI/CD Restructuring & Enhanced Automation
+
+#### 🔧 GitFlow CI/CD Restructuring
+- **Develop Branch Automation**: Removed PyPI deployment from develop branch, now only runs tests, builds, and README updates
+- **Release Branch Workflow**: Created dedicated `.github/workflows/release-automation.yml` for PyPI deployment on release branches
+- **Hotfix Branch Workflow**: Created dedicated `.github/workflows/hotfix-automation.yml` for emergency PyPI deployments
+- **GitFlow Compliance**: CI/CD now follows proper GitFlow strategy: develop → release → main → PyPI deployment
+
+#### 🛠️ New CI/CD Workflows
+
+##### Release Automation (`release/v*` branches)
+- **Automated Testing**: Full test suite execution with coverage reporting
+- **Package Building**: Automated package building and validation
+- **PyPI Deployment**: Automatic deployment to PyPI after successful tests
+- **Main Branch PR**: Creates automatic PR to main branch after deployment
+
+##### Hotfix Automation (`hotfix/*` branches)
+- **Critical Bug Fixes**: Dedicated workflow for production-critical fixes
+- **Rapid Deployment**: Fast-track PyPI deployment for urgent fixes
+- **Main Branch PR**: Automatic PR creation to main branch
+
+#### 🎯 GitFlow Helper Script
+- **Automated Operations**: `scripts/gitflow_helper.py` for streamlined GitFlow operations
+- **Branch Management**: Commands for feature, release, and hotfix branch operations
+- **Developer Experience**: Simplified GitFlow workflow following
+
+#### 🧪 Quality Improvements
+- **README Statistics**: Enhanced tolerance ranges for coverage updates (0.1% tolerance)
+- **Precision Control**: Coverage rounded to 1 decimal place to prevent unnecessary updates
+- **Validation Consistency**: Unified tolerance logic between update and validation processes
+
+#### 📚 Documentation Updates
+- **GitFlow Guidelines**: Enhanced `GITFLOW_zh.md` with CI/CD integration details
+- **Workflow Documentation**: Comprehensive documentation for all CI/CD workflows
+- **Developer Guidelines**: Clear instructions for GitFlow operations
+
+---
+
+## [1.0.0] - 2025-08-19
+
+### 🎉 Major Release: CI Test Failures Resolution & GitFlow Implementation
+
+#### 🔧 CI Test Failures Resolution
+- **Cross-Platform Path Compatibility**: Fixed Windows short path names (8.3 format) and macOS symlink differences
+- **Windows Environment**: Implemented robust path normalization using Windows API (`GetLongPathNameW`)
+- **macOS Environment**: Fixed `/var` vs `/private/var` symlink differences in path resolution
+- **Test Infrastructure**: Enhanced test files with platform-specific path normalization functions
+
+#### 🛠️ Technical Improvements
+
+##### Path Normalization System
+- **Windows API Integration**: Added `GetLongPathNameW` for handling short path names (8.3 format)
+- **macOS Symlink Handling**: Implemented `/var` vs `/private/var` path normalization
+- **Cross-Platform Consistency**: Unified path comparison across Windows, macOS, and Linux
+
+##### Test Files Enhanced
+- `tests/test_path_resolver.py`: Added macOS symlink handling
+- `tests/test_path_resolver_extended.py`: Enhanced Windows 8.3 path normalization
+- `tests/test_project_detector.py`: Improved platform-specific path handling
+
+#### 🏗️ GitFlow Branch Strategy Implementation
+- **Develop Branch**: Created `develop` branch for ongoing development
+- **Hotfix Workflow**: Implemented proper hotfix branch workflow
+- **Release Management**: Established foundation for release branch strategy
+
+#### 🧪 Quality Assurance
+- **Test Coverage**: 1504 tests with 74.37% coverage
+- **Cross-Platform Testing**: All tests passing on Windows, macOS, and Linux
+- **CI/CD Pipeline**: GitHub Actions workflow fully functional
+- **Code Quality**: All pre-commit hooks passing
+
+#### 📚 Documentation Updates
+- **README Statistics**: Updated test count and coverage across all language versions
+- **CI Documentation**: Enhanced CI workflow documentation
+- **Branch Strategy**: Documented GitFlow implementation
+
+#### 🚀 Release Highlights
+- **Production Ready**: All CI issues resolved, ready for production use
+- **Cross-Platform Support**: Full compatibility across Windows, macOS, and Linux
+- **Enterprise Grade**: Robust error handling and comprehensive testing
+- **AI Integration**: Enhanced MCP server compatibility for AI tools
+
+---
+
 ## [0.9.9] - 2025-08-17
 
 ### 📚 Documentation Updates

tree_sitter_analyzer-1.1.0/GITFLOW.md

@@ -0,0 +1,287 @@
+# GitFlow Branch Strategy
+
+This document describes the GitFlow branch strategy implemented for the tree-sitter-analyzer project.
+
+## GitFlow Diagram
+
+```mermaid
+gitGraph
+    commit id: "Initial commit"
+    branch develop
+    commit id: "dev-1"
+    
+    branch feature/my-feature
+    commit id: "feat-1"
+    commit id: "feat-2"
+    
+    checkout develop
+    merge feature/my-feature id: "merge-feat"
+    
+    branch release/v1.0.0
+    commit id: "release-prep"
+    
+    checkout main
+    merge release/v1.0.0 tag: "v1.0.0"
+    
+    checkout develop
+    merge release/v1.0.0
+    
+    checkout main
+    branch hotfix/critical-fix
+    commit id: "fix-bug"
+    
+    checkout main
+    merge hotfix/critical-fix tag: "v1.0.1"
+    
+    checkout develop
+    merge hotfix/critical-fix
+```
+
+## Branch Structure
+
+### Main Branches
+
+- **`main`**: Production-ready code. Always contains the latest stable release.
+- **`develop`**: Integration branch for features. Contains the latest delivered development changes.
+
+### Supporting Branches
+
+- **`feature/*`**: Feature development branches. Branch from `develop`, merge back to `develop`.
+- **`release/*`**: Release preparation branches. Branch from `develop`, merge to both `main` and `develop`.
+- **`hotfix/*`**: Critical bug fixes for production. Branch from `main`, merge to both `main` and `develop`.
+
+## Workflow
+
+### Feature Development
+
+1. **Create feature branch** from `develop`:
+   ```bash
+   git checkout develop
+   git pull origin develop
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Develop your feature** with regular commits:
+   ```bash
+   git add .
+   git commit -m "feat: Add new feature"
+   ```
+
+3. **Push feature branch** and create pull request:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+4. **Merge to develop** after code review and CI passes.
+
+### Release Process
+
+#### Automated Release (Recommended)
+
+The project now uses an **automated release process** from the `develop` branch:
+
+1. **Develop branch updates** trigger automatic:
+   - ✅ Test execution
+   - ✅ PyPI deployment
+   - ✅ README statistics update
+   - ✅ Pull request creation to main
+
+2. **Manual review and merge** of the automated PR to main
+
+3. **GitHub release creation** with proper versioning
+
+#### Manual Release Process
+
+For manual releases:
+
+1. **Create release branch** from `develop`:
+   ```bash
+   git checkout develop
+   git pull origin develop
+   git checkout -b release/v1.0.0
+   ```
+
+2. **Update version** in `pyproject.toml`:
+   ```toml
+   version = "1.0.0"
+   ```
+
+3. **Update documentation**:
+   ```bash
+   uv run python scripts/improved_readme_updater.py
+   ```
+
+4. **Commit changes**:
+   ```bash
+   git add .
+   git commit -m "chore: Prepare release v1.0.0"
+   ```
+
+5. **Merge to main and develop**:
+   ```bash
+   git checkout main
+   git merge release/v1.0.0
+   git tag -a v1.0.0 -m "Release v1.0.0"
+   git push origin main --tags
+   
+   git checkout develop
+   git merge release/v1.0.0
+   git push origin develop
+   ```
+
+6. **Delete release branch**:
+   ```bash
+   git branch -d release/v1.0.0
+   git push origin --delete release/v1.0.0
+   ```
+
+### Hotfix Process
+
+1. **Create hotfix branch** from `main`:
+   ```bash
+   git checkout main
+   git pull origin main
+   git checkout -b hotfix/critical-bug-fix
+   ```
+
+2. **Fix the issue** and commit:
+   ```bash
+   git add .
+   git commit -m "fix: Critical bug fix"
+   ```
+
+3. **Update version** for hotfix:
+   ```bash
+   # Update pyproject.toml version (e.g., 1.0.0 -> 1.0.1)
+   ```
+
+4. **Merge to main and develop**:
+   ```bash
+   git checkout main
+   git merge hotfix/critical-bug-fix
+   git tag -a v1.0.1 -m "Hotfix v1.0.1"
+   git push origin main --tags
+   
+   git checkout develop
+   git merge hotfix/critical-bug-fix
+   git push origin develop
+   ```
+
+5. **Delete hotfix branch**:
+   ```bash
+   git branch -d hotfix/critical-bug-fix
+   git push origin --delete hotfix/critical-bug-fix
+   ```
+
+## Automation Features
+
+### Develop Branch Automation
+
+When code is pushed to `develop`, the following happens automatically:
+
+1. **Test Execution**: All tests are run to ensure quality
+2. **PyPI Deployment**: Package is built and deployed to PyPI
+3. **README Update**: Statistics are automatically updated
+4. **PR Creation**: Pull request is created to main branch
+
+### Main Branch Protection
+
+The `main` branch is protected with:
+
+- ✅ **Required status checks**: All CI jobs must pass
+- ✅ **Required pull request reviews**: At least 1 approval required
+- ✅ **Branch up-to-date requirement**: Must be up-to-date with base branch
+- ✅ **Conversation resolution**: All review comments must be resolved
+
+### Automated Release Script
+
+Use the automated release script for manual releases:
+
+```bash
+# Dry run to see what would happen
+uv run python scripts/automated_release.py --dry-run
+
+# Execute release with new version
+uv run python scripts/automated_release.py --version 1.1.0
+
+# Execute release with current version
+uv run python scripts/automated_release.py
+```
+
+## Best Practices
+
+### Commit Messages
+
+Use conventional commit format:
+
+- `feat:` New features
+- `fix:` Bug fixes
+- `docs:` Documentation changes
+- `style:` Code style changes (formatting, etc.)
+- `refactor:` Code refactoring
+- `test:` Adding or updating tests
+- `chore:` Maintenance tasks
+
+### Branch Naming
+
+- `feature/descriptive-name`: Feature branches
+- `release/v1.0.0`: Release branches
+- `hotfix/critical-fix`: Hotfix branches
+
+### Quality Checks
+
+Before merging to `develop`:
+
+1. **Run tests locally**:
+   ```bash
+   uv run pytest tests/ -v
+   ```
+
+2. **Check code quality**:
+   ```bash
+   uv run python check_quality.py --new-code-only
+   ```
+
+3. **Update documentation** if needed:
+   ```bash
+   uv run python scripts/improved_readme_updater.py
+   ```
+
+### Version Management
+
+- **Semantic Versioning**: MAJOR.MINOR.PATCH
+- **Automatic versioning**: Managed by automated release process
+- **Version consistency**: All files updated together
+
+## CI/CD Integration
+
+### GitHub Actions Workflows
+
+1. **`ci.yml`**: Main CI pipeline for all branches
+2. **`develop-automation.yml`**: Automated release from develop
+3. **`branch-protection.yml`**: Main branch protection setup
+
+### Required Secrets
+
+- `PYPI_API_TOKEN`: For PyPI deployment
+- `GITHUB_TOKEN`: For repository operations
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Branch protection errors**: Ensure all required checks pass
+2. **PyPI deployment failures**: Check API token and package validity
+3. **README update failures**: Verify test statistics are accurate
+
+### Manual Override
+
+For emergency situations, repository administrators can:
+
+1. **Bypass branch protection** (use with caution)
+2. **Manual PyPI deployment** if automated process fails
+3. **Force push** to main (only in critical situations)
+
+---
+
+**Note**: This GitFlow implementation prioritizes automation and quality assurance while maintaining the flexibility for manual intervention when needed.

tree_sitter_analyzer-1.1.0/GITFLOW_ja.md

@@ -0,0 +1,124 @@
+# GitFlow ブランチ戦略 (日本語説明)
+
+このドキュメントでは、`tree-sitter-analyzer`プロジェクトで実装されているGitFlowブランチ戦略を、Mermaidチャートと日本語で解説します。
+
+## GitFlow フロー図
+
+```mermaid
+gitGraph
+    commit id: "Initial commit"
+    branch develop
+    commit id: "dev-1"
+    
+    branch feature/my-feature
+    commit id: "feat-1"
+    commit id: "feat-2"
+    
+    checkout develop
+    merge feature/my-feature id: "merge-feat"
+    
+    branch release/v1.0.0
+    commit id: "release-prep"
+    
+    checkout main
+    merge release/v1.0.0 tag: "v1.0.0"
+    
+    checkout develop
+    merge release/v1.0.0
+    
+    checkout main
+    branch hotfix/critical-fix
+    commit id: "fix-bug"
+    
+    checkout main
+    merge hotfix/critical-fix tag: "v1.0.1"
+    
+    checkout develop
+    merge hotfix/critical-fix
+```
+
+## ブランチ構造
+
+### 主要ブランチ
+
+- **`main`**: 本番環境に対応したコード。常に最新の安定版リリースが含まれます。いつでもデプロイ可能な状態であるべきです。
+- **`develop`**: 機能統合用のブランチ。最新の開発変更が含まれており、すべての機能開発の起点となります。
+
+### サポートブランチ
+
+- **`feature/*`**: 機能開発用のブランチ。
+    - **派生元**: `develop`
+    - **マージ先**: `develop`
+    - **命名規則**: `feature/descriptive-name` (例: `feature/user-authentication`)
+- **`release/*`**: リリース準備用のブランチ。新しい本番リリースの準備に使用され、軽微なバグ修正やドキュメント生成など、リリースに関連するタスクのみを行います。
+    - **派生元**: `develop`
+    - **マージ先**: `main` と `develop`
+    - **命名規則**: `release/v1.2.0`
+- **`hotfix/*`**: 緊急の本番バグ修正用のブランチ。本番環境での重大な問題を迅速に修正するために使用されます。
+    - **派生元**: `main`
+    - **マージ先**: `main` と `develop`
+    - **命名規則**: `hotfix/critical-bug-fix`
+
+## ワークフロー
+
+### 1. 機能開発 (Feature Development)
+
+1.  **`develop` から `feature` ブランチを作成**:
+    ```bash
+    git checkout develop
+    git pull origin develop
+    git checkout -b feature/your-feature-name
+    ```
+2.  **機能開発を行い**、定期的にコミットします。
+3.  **開発完了後**、`feature` ブランチをリモートにプッシュし、`develop` ブランチへのプルリクエストを作成します。
+4.  コードレビューと継続的インテグレーション（CI）のチェックを通過後、**`develop` にマージ**します。
+
+### 2. リリースプロセス (Release Process)
+
+プロジェクトでは自動化されたリリースプロセスを推奨していますが、手動のプロセスは以下の通りです。
+
+1.  **`develop` から `release` ブランチを作成**:
+    ```bash
+    git checkout -b release/v1.0.0 develop
+    ```
+2.  **リリース準備**: バージョン番号の更新、ドキュメントの生成など。
+3.  **準備完了後、`main` と `develop` にマージ**:
+    ```bash
+    # mainブランチに切り替えてマージ
+    git checkout main
+    git merge release/v1.0.0
+    git tag -a v1.0.0 -m "Release v1.0.0" # バージョンタグを付与
+    git push origin main --tags
+
+    # developブランチに切り替えてマージ
+    git checkout develop
+    git merge release/v1.0.0
+    git push origin develop
+    ```
+4.  **`release` ブランチを削除**します。
+
+### 3. 緊急修正 (Hotfix Process)
+
+1.  **`main` から `hotfix` ブランチを作成**:
+    ```bash
+    git checkout -b hotfix/critical-bug-fix main
+    ```
+2.  **バグを修正**し、コミットします。
+3.  **修正完了後、`main` と `develop` にマージ**:
+    ```bash
+    # mainブランチに切り替えてマージ
+    git checkout main
+    git merge hotfix/critical-bug-fix
+    git tag -a v1.0.1 -m "Hotfix v1.0.1" # 修正バージョンタグを付与
+    git push origin main --tags
+
+    # developブランチに切り替えてマージ
+    git checkout develop
+    git merge hotfix/critical-bug-fix
+    git push origin develop
+    ```
+4.  **`hotfix` ブランチを削除**します。
+
+---
+
+*この日本語説明は、[`GITFLOW.md`](GITFLOW.md) の中核的な概念を理解するのに役立ちます。自動化プロセス、品質チェック、CI/CD統合に関する詳細は、元のドキュメントを参照してください。*

tree_sitter_analyzer-1.1.0/GITFLOW_zh.md

@@ -0,0 +1,124 @@
+# GitFlow 分支策略 (中文说明)
+
+本文档使用 Mermaid 图表和中文解释了 `tree-sitter-analyzer` 项目中实施的 GitFlow 分支策略。
+
+## GitFlow 流程图
+
+```mermaid
+gitGraph
+    commit id: "Initial commit"
+    branch develop
+    commit id: "dev-1"
+    
+    branch feature/my-feature
+    commit id: "feat-1"
+    commit id: "feat-2"
+    
+    checkout develop
+    merge feature/my-feature id: "merge-feat"
+    
+    branch release/v1.0.0
+    commit id: "release-prep"
+    
+    checkout main
+    merge release/v1.0.0 tag: "v1.0.0"
+    
+    checkout develop
+    merge release/v1.0.0
+    
+    checkout main
+    branch hotfix/critical-fix
+    commit id: "fix-bug"
+    
+    checkout main
+    merge hotfix/critical-fix tag: "v1.0.1"
+    
+    checkout develop
+    merge hotfix/critical-fix
+```
+
+## 分支结构
+
+### 主要分支
+
+- **`main`**: 生产就绪的代码。始终包含最新的稳定版本。任何时候都应该是可部署的状态。
+- **`develop`**: 功能集成分支。包含最新的已交付开发变更，是所有功能开发的起点。
+
+### 支持分支
+
+- **`feature/*`**: 功能开发分支。
+    - **来源**: `develop`
+    - **合并回**: `develop`
+    - **命名**: `feature/descriptive-name` (例如: `feature/user-authentication`)
+- **`release/*`**: 版本发布准备分支。用于准备新的生产版本，只进行少量 Bug 修复和文档生成等面向发布的任务。
+    - **来源**: `develop`
+    - **合并回**: `main` 和 `develop`
+    - **命名**: `release/v1.2.0`
+- **`hotfix/*`**: 紧急生产 Bug 修复分支。用于快速修复生产环境中的关键问题。
+    - **来源**: `main`
+    - **合并回**: `main` 和 `develop`
+    - **命名**: `hotfix/critical-bug-fix`
+
+## 工作流程
+
+### 1. 功能开发 (Feature Development)
+
+1.  **从 `develop` 创建 `feature` 分支**:
+    ```bash
+    git checkout develop
+    git pull origin develop
+    git checkout -b feature/your-feature-name
+    ```
+2.  **进行功能开发**并定期提交。
+3.  **开发完成后**，将 `feature` 分支推送到远程，并创建拉取请求 (Pull Request) 到 `develop` 分支。
+4.  经过代码审查和持续集成 (CI) 检查通过后，**合并到 `develop`**。
+
+### 2. 版本发布 (Release Process)
+
+项目推荐使用自动化发布流程，但手动流程如下：
+
+1.  **从 `develop` 创建 `release` 分支**:
+    ```bash
+    git checkout -b release/v1.0.0 develop
+    ```
+2.  **准备发布**: 更新版本号、生成文档等。
+3.  **完成准备后，合并到 `main` 和 `develop`**:
+    ```bash
+    # 切换到 main 分支并合并
+    git checkout main
+    git merge release/v1.0.0
+    git tag -a v1.0.0 -m "Release v1.0.0" # 打上版本标签
+    git push origin main --tags
+
+    # 切换到 develop 分支并合并
+    git checkout develop
+    git merge release/v1.0.0
+    git push origin develop
+    ```
+4.  **删除 `release` 分支**。
+
+### 3. 紧急修复 (Hotfix Process)
+
+1.  **从 `main` 创建 `hotfix` 分支**:
+    ```bash
+    git checkout -b hotfix/critical-bug-fix main
+    ```
+2.  **修复 Bug** 并提交。
+3.  **完成修复后，合并到 `main` 和 `develop`**:
+    ```bash
+    # 切换到 main 分支并合并
+    git checkout main
+    git merge hotfix/critical-bug-fix
+    git tag -a v1.0.1 -m "Hotfix v1.0.1" # 打上修复版本标签
+    git push origin main --tags
+
+    # 切换到 develop 分支并合并
+    git checkout develop
+    git merge hotfix/critical-bug-fix
+    git push origin develop
+    ```
+4.  **删除 `hotfix` 分支**。
+
+---
+
+*此中文说明旨在帮助理解 `GITFLOW.md` 中的核心概念。更详细的自动化流程、质量检查和 CI/CD 集成信息，请参阅原始的 [GITFLOW.md](GITFLOW.md) 文件。*