jfox-cli 0.1.3__tar.gz → 0.1.5__tar.gz

{jfox_cli-0.1.3 → jfox_cli-0.1.5}/.github/workflows/integration-test.yml

@@ -14,6 +14,7 @@ on:
       - 'jfox/**'
       - 'tests/**'
       - 'pyproject.toml'
+      - '.github/workflows/integration-test.yml'
   # 允许手动触发
   workflow_dispatch:
     inputs:
@@ -33,6 +34,32 @@ env:
   PYTHONUTF8: 1
 
 jobs:
+  # ============ Lint 检查 ============
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+        enable-cache: true
+
+    - name: Install dependencies
+      run: uv sync --extra dev
+
+    - name: Run ruff check
+      run: uv run ruff check jfox/ tests/
+
+    - name: Run black check
+      run: uv run black --check jfox/ tests/
+
   # ============ 快速测试（PR 和 push 触发）============
   test-fast:
     runs-on: ${{ matrix.os }}
@@ -102,12 +129,20 @@ jobs:
         version: "latest"
         enable-cache: true
 
-    - name: Cache model
+    - name: Cache model (Unix)
+      if: runner.os != 'Windows'
       uses: actions/cache@v4
       with:
         path: ~/.cache/torch/sentence_transformers
         key: ${{ runner.os }}-sentence-transformers-all-MiniLM-L6-v2
 
+    - name: Cache model (Windows)
+      if: runner.os == 'Windows'
+      uses: actions/cache@v4
+      with:
+        path: ~\AppData\Local\torch\sentence_transformers
+        key: ${{ runner.os }}-sentence-transformers-all-MiniLM-L6-v2
+
     - name: Install dependencies
       run: uv sync --extra dev
 
@@ -152,12 +187,20 @@ jobs:
         version: "latest"
         enable-cache: true
 
-    - name: Cache model
+    - name: Cache model (Unix)
+      if: runner.os != 'Windows'
       uses: actions/cache@v4
       with:
         path: ~/.cache/torch/sentence_transformers
         key: ${{ runner.os }}-sentence-transformers-all-MiniLM-L6-v2
 
+    - name: Cache model (Windows)
+      if: runner.os == 'Windows'
+      uses: actions/cache@v4
+      with:
+        path: ~\AppData\Local\torch\sentence_transformers
+        key: ${{ runner.os }}-sentence-transformers-all-MiniLM-L6-v2
+
     - name: Install dependencies
       run: uv sync --extra dev
 
@@ -178,7 +221,25 @@ jobs:
         path: |
           .pytest_cache/
 
-  # ============ 覆盖率报告汇总 ============
+  # ============ 质量门禁（所有必须测试通过才算成功）============
+  quality-gate:
+    runs-on: ubuntu-latest
+    needs: [lint, test-fast]
+    if: always()
+    steps:
+    - name: Check all jobs passed
+      run: |
+        echo "lint: ${{ needs.lint.result }}"
+        echo "test-fast: ${{ needs.test-fast.result }}"
+        if [[ "${{ needs.lint.result }}" == "success" && "${{ needs.test-fast.result }}" == "success" ]]; then
+          echo "Quality gate passed!"
+          exit 0
+        else
+          echo "Quality gate FAILED!"
+          exit 1
+        fi
+
+  # ============ 覆盖率报告（仅 fast 测试通过后）============
   coverage:
     runs-on: ubuntu-latest
     needs: [test-fast]
@@ -203,9 +264,42 @@ jobs:
 
     - name: Run coverage
       run: |
-        uv run pytest tests/ -m "not embedding and not slow" --cov=jfox --cov-report=xml --cov-report=html -v --timeout=300
+        uv run pytest tests/ -m "not embedding and not slow" --cov=jfox --cov-report=xml --cov-report=html --cov-report=term -v --timeout=300
       timeout-minutes: 25
 
+    - name: Post coverage comment on PR
+      if: github.event_name == 'pull_request'
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        python -c "
+        import xml.etree.ElementTree as ET
+        import subprocess
+
+        tree = ET.parse('coverage.xml')
+        root = tree.getroot()
+        rate = float(root.attrib['line-rate'])
+        lines_covered = int(root.attrib['lines-covered'])
+        lines_valid = int(root.attrib['lines-valid'])
+
+        rows = []
+        for cls in root.iter('class'):
+            name = cls.attrib['filename']
+            r = float(cls.attrib['line-rate'])
+            rows.append((name, r))
+        rows.sort(key=lambda x: x[1])
+
+        comment = '## Test Coverage\n\n'
+        comment += '**Overall: {:.1f}%** ({}/{} lines)\n\n'.format(rate * 100, lines_covered, lines_valid)
+        comment += '| Module | Coverage | Status |\n|--------|----------|--------|\n'
+        for name, r in rows:
+            icon = ':green_circle:' if r >= 0.8 else ':yellow_circle:' if r >= 0.5 else ':red_circle:'
+            comment += '| {} | {:.1f}% | {} |\n'.format(name, r * 100, icon)
+
+        pr = '${{ github.event.pull_request.number }}'
+        subprocess.run(['gh', 'pr', 'comment', pr, '--body', comment])
+        "
+
     - name: Upload coverage report
       uses: actions/upload-artifact@v4
       with:

{jfox_cli-0.1.3 → jfox_cli-0.1.5}/CLAUDE.md

@@ -91,6 +91,7 @@ Notes are Markdown files with YAML frontmatter stored under `~/.zettelkasten/<kb
 
 ## Conventions
 
+- **Version bump**: 发版时必须同时修改 `pyproject.toml` 和 `jfox/__init__.py` 两处版本号（曾有 #88 遗漏 `__init__.py` 的教训）
 - **Line length**: 100 chars (black + ruff configured in `pyproject.toml`)
 - **Comments/docs**: Chinese (中文)
 - **Adding a CLI command**: Add `@app.command()` in `cli.py`, implement `_xxx_impl()` helper, add `--kb` and `--format json` support
@@ -125,6 +126,10 @@ Four jobs in `.github/workflows/integration-test.yml`:
 - Set `PYTHONUTF8=1` and `chcp 65001` for encoding
 - HuggingFace mirror for China: `export HF_ENDPOINT=https://hf-mirror.com`
 
+## Branch Rules
+
+- **main 是保护分支**，不能直接 commit 或 push。所有改动必须通过新分支 + PR 合入。
+
 ## Gotchas
 
 - `pytest.ini` `addopts` includes `-v`, so `pytest tests/` already runs verbose — adding `-v` manually is redundant

{jfox_cli-0.1.3 → jfox_cli-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jfox-cli
-Version: 0.1.3
+Version: 0.1.5
 Summary: JFox - Zettelkasten 知识管理 CLI 工具
 Project-URL: Homepage, https://github.com/zhuxixi/jfox
 Project-URL: Repository, https://github.com/zhuxixi/jfox

{jfox_cli-0.1.3 → jfox_cli-0.1.5}/jfox/__init__.py

@@ -1,5 +1,5 @@
 """JFox - Zettelkasten 知识管理工具"""
 
-__version__ = "0.1.3"
+__version__ = "0.1.5"
 __author__ = "User"
 __email__ = "user@example.com"